Skip to content

docs(release): add maintainer release guide and link it from docs#789

Merged
lcottercertinia merged 1 commit into
certinia:mainfrom
lukecotter:chore-releasing-doc
May 29, 2026
Merged

docs(release): add maintainer release guide and link it from docs#789
lcottercertinia merged 1 commit into
certinia:mainfrom
lukecotter:chore-releasing-doc

Conversation

@lukecotter
Copy link
Copy Markdown
Contributor

📝 PR Overview

Adds RELEASING.md, a concise maintainer guide covering the versioning convention, automated pre-release flow, and manual stable release flow. Cross-links it from CONTRIBUTING.md and DEVELOPING.md so maintainers can find it from both entry points.

🛠️ Changes made

  • Add RELEASING.md with stable/pre-release versioning rules, odd/even minor convention rationale, pre-release automation overview, and stable release checklist
  • Document when to use main vs a release branch (older-version patch lines only)
  • Add maintainer note to CONTRIBUTING.md linking to the new guide
  • Update DEVELOPING.md packaging section to reference RELEASING.md

🧩 Type of change (check all applicable)

  • 🐛 Bug fix - something not working as expected
  • ✨ New feature – adds new functionality
  • ♻️ Refactor - internal changes with no user impact
  • ⚡ Performance Improvement
  • 📝 Documentation - README or documentation site changes
  • 🔧 Chore - dev tooling, CI, config
  • 💥 Breaking change

📷 Screenshots / gifs / video [optional]

Show off your UI changes.

🔗 Related Issues

related #

✅ Tests added?

  • 👍 yes
  • 🙅 no, not needed
  • 🙋 no, I need help

📚 Docs updated?

  • 🔖 README.md
  • 🔖 CHANGELOG.md
  • 📖 help site
  • 🙅 not needed

Anything else we need to know? [optional]

- add RELEASING.md with concise stable/pre-release process and versioning rules
- document when to use main vs a release branch for older-line patch releases
- cross-link CONTRIBUTING.md and DEVELOPING.md to the release guide for maintainers
@lcottercertinia lcottercertinia merged commit 1b287b5 into certinia:main May 29, 2026
5 of 6 checks passed
@lukecotter lukecotter deleted the chore-releasing-doc branch May 29, 2026 16:21
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.

2 participants