Check API manual and man pages before release #4309
Conversation
This file contains 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
ensures it's properly updated
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds 2 checks in CI
to ensure that the man pages and the API manual are correctly updated before reaching the
releasebranch.This will avoid issues like #4301 in the future.
These new tests are triggered when merging or presenting a PR onto the
releasebranch (only).They were tested in my local fork.
For instance, after making an intentional modification to
zstd.1.md, it triggered the following error signal: https://github.com/Cyan4973/zstd/actions/runs/13444836104/job/37567684872?pr=4