doc/script: fix missing role colons, refresh release guide and sign off release commits - #707
Merged
Merged
Conversation
Six cross-references are written as "mfcmd:`...`" or "ref:`...`" without the leading colon, so Sphinx renders them as literal text instead of links to the modulefile command or man page they name. Assisted-by: Claude:claude-fable-5-1 Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
Point to the 5.7.0 release commit as the example to follow, as it reflects the current set of files touched by a release. Add the step to update the version substitutions in other-implementations.rst, which this commit had to change but the guide did not mention. Clarify that MIGRATING.rst only gets its "not yet released" mention dropped, as no release date is written there. Strip the :mhook: role, introduced by the hook feature, when building the GitHub release description from NEWS.rst. Assisted-by: Claude:claude-fable-5-1 Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
Every commit in the repository must carry a Signed-off-by trailer, but the "release of version" commit that mpub creates on the gh-pages branch was made without it. Pass -s to git commit there, and in the release guide's commit step for the main branch, so both release commits comply with the DCO. Assisted-by: Claude:claude-fable-5-1 Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
xdelaruelle
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three small fixes around documentation and the release process.
mfcmd:...or `ref:`...without the leading colon, so Sphinx renders them as literal text instead of links. Add the missing colon.other-implementations.rst(which that release had to touch but the guide did not mention), clarify thatMIGRATING.rstonly gets its "not yet released" mention dropped, and strip the:mhook:role when building the GitHub release description fromNEWS.rst.script/mpubcreates on thegh-pagesbranch was made without aSigned-off-by:trailer. Pass-stogit committhere, and in the release guide's commit step for the main branch, so both release commits comply with the DCO.