Skip to content

chore: place Maintenance before Documentation in release notes#8304

Closed
anevolbap wants to merge 1 commit into
pymc-devs:mainfrom
anevolbap:chore/release-notes-maintenance-before-docs
Closed

chore: place Maintenance before Documentation in release notes#8304
anevolbap wants to merge 1 commit into
pymc-devs:mainfrom
anevolbap:chore/release-notes-maintenance-before-docs

Conversation

@anevolbap
Copy link
Copy Markdown
Contributor

Closes #8296.

Swaps the order of the Maintenance and Documentation categories in .github/release.yml, so that Documentation renders at the bottom of the auto-generated release notes (rationale from the issue: docs entries are usually typos and minor, so they belong last).

     - title: Bugfixes 🪲
       labels:
         - bug
-    - title: Documentation 📖
-      labels:
-        - docs
     - title: Maintenance 🔧
       labels:
         - "*"
+    - title: Documentation 📖
+      labels:
+        - docs

Per GitHub's docs on automatically generated release notes, "*" is a catch-all for PRs not matched by any other category, regardless of its position in the list. So docs-labeled PRs continue to land in Documentation; only the display order changes. The change only takes effect at the next release.

@welcome
Copy link
Copy Markdown

welcome Bot commented May 18, 2026

Thank You Banner]
💖 Thanks for opening this pull request! 💖 The PyMC community really appreciates your time and effort to contribute to the project. Please make sure you have read our Contributing Guidelines and filled in our pull request template to the best of your ability.

@anevolbap anevolbap marked this pull request as ready for review May 18, 2026 10:19
@read-the-docs-community
Copy link
Copy Markdown

Documentation build overview

📚 pymc | 🛠️ Build #32734808 | 📁 Comparing f3f63c9 against latest (169e901)

  🔍 Preview build  

1 file changed
± glossary.html

@ricardoV94
Copy link
Copy Markdown
Member

Per GitHub's docs on automatically generated release notes, "*" is a catch-all for PRs not matched by any other category, regardless of its position in the list. So docs-labeled PRs continue to land in Documentation; only the display order changes. The change only takes effect at the next release.

That's not how I read it. Maybe the solution to this issue is to do nothing at all, but not mark typos and the like as docs

@anevolbap
Copy link
Copy Markdown
Contributor Author

My bad. I misread the spec. * catches PRs not matched by previous categories, so this would have emptied Documentation. Closing.

@anevolbap anevolbap closed this May 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Release notes: place maintenance before docs

2 participants