Skip to content

Automate creating releases from Changelog and add Changelog to docs#954

Open
edwardchalstrey1 wants to merge 11 commits into
masterfrom
doc/712
Open

Automate creating releases from Changelog and add Changelog to docs#954
edwardchalstrey1 wants to merge 11 commits into
masterfrom
doc/712

Conversation

@edwardchalstrey1

@edwardchalstrey1 edwardchalstrey1 commented Jun 19, 2026

Copy link
Copy Markdown
Member

Issues closed by this PR

Description of the changes in this PR

This PR:

  • Updates the install page with clearer instructions and links to the releases
  • Shows the ChangeLog in the docs via a symlink on the install page and myst-parser, so release history is part of the documentation site rather than only available on GitHub.
  • Automate GitHub release creation with a new .github/workflows/release.yml workflow.
    • When a vX.Y.Z tag is pushed, the workflow extracts the matching section from ChangeLog and creates the GitHub release with those notes - no need to copy and paste
    • Updates the developer release doc (doc/developer.contributing.rst) to reflect that step 6 (GitHub release creation) is now automated, and to clarify that ChangeLog is the single source of truth for release notes.
  • The extraction script which gets the info from the Changelog for the docs (used by the GH workflow) is added in build_support/releases with tests. This ensures the Changelog is always formatted correctly (also explained in contributor docs)
  • Adds myst-parser to the documentation dependencies (pyproject.toml and doc/conf.py) to support Markdown source files in Sphinx.

How to review this PR

@edwardchalstrey1 edwardchalstrey1 changed the title docs: Improve & automate release process Automate creating releases from Changelog and add Changelog to docs Jun 19, 2026
@edwardchalstrey1 edwardchalstrey1 marked this pull request as ready for review June 19, 2026 13:40
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.

[Documentation]: Improve & automate release notes to not rely on GitHub

1 participant