Skip to content

Doc: Update release.rst with latest guidelines - #4713

Open
loichuder wants to merge 1 commit into
mainfrom
update-contributing-doc
Open

Doc: Update release.rst with latest guidelines#4713
loichuder wants to merge 1 commit into
mainfrom
update-contributing-doc

Conversation

@loichuder

Copy link
Copy Markdown
Member

PR summary

  • Describe new "lazy" handling of bugfix releases
  • Remove section about doc deployment
  • Add section about updating of consumer packages (apptainer/docker)

AI Disclosure

  • No AI used

Comment thread doc/source/contribute/release.rst Outdated

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this section still relevant?

It does not really describe what to do with the binaries afterwards.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It just describes what the release workflow is doing, all there is to do is approve the deployment.
Same for Publish to pypi section.

Not sure it is relevant as it is. I propose to replace both with a single section, e.g.:

Approve deployments
...............

Once the release workflow requests it, approve the "assets" and "pypi" `deployment environment`_ to publish the release artifacts.

@loichuder
loichuder requested a review from t20100 September 2, 2026 12:12
Comment thread doc/source/contribute/release.rst Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It just describes what the release workflow is doing, all there is to do is approve the deployment.
Same for Publish to pypi section.

Not sure it is relevant as it is. I propose to replace both with a single section, e.g.:

Approve deployments
...............

Once the release workflow requests it, approve the "assets" and "pypi" `deployment environment`_ to publish the release artifacts.

@loichuder
loichuder force-pushed the update-contributing-doc branch from 9692125 to 52df27e Compare September 2, 2026 14:54
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