Reimplement bump-readme.sh in Go #304
Merged
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
This is primarily just moving the existing functionality within functions so that the script is easier to read, and so that when a subsequent upcoming change deletes portions of the functionality, the diff is easier to read. Might break something, didn't test this intermediate form. Signed-off-by: Joe Stringer <[email protected]>
This comment was marked as resolved.
This comment was marked as resolved.
joestringer
force-pushed
the
pr/joe/bump-readme
branch
from
b8e69ac to
e4427b6
Compare
joestringer
commented
Mar 4, 2025
joestringer
force-pushed
the
pr/joe/bump-readme
branch
5 times, most recently
from
5255fe3 to
ab0e73c
Compare
This replaces the core implementation of bump-readme.sh with Go. The new Go tool takes a versions.json input that has a list of release versions and dates, as well as taking the README.rst on stdin, and it substitutes the versions with the latest versions from the JSON file, sending the output to stdout. The bump-readme.sh script is now reduced in scope to remove most sed usage, it now: - Pulls the latest release versions & dates from the GitHub API - Pushes the latest stable release version into stable.txt and Documentation/_static/stable-version.json - Runs the Go implementation to substitute the versions correctly - Checks the table formatting to complain if it is misaligned Overall this should make the implementation more reliable in replacing the relevant version / date fields, regardless of what the latest versions are. It also significantly reduces the usage of sed, which should generally bring this scripting closer to cross-platform friendliness. Finally with more of the implementation in Go, if something is wrong, the community is more likely to be able to dig into why and propose a fix. Signed-off-by: Joe Stringer <[email protected]>
joestringer
force-pushed
the
pr/joe/bump-readme
branch
from
ab0e73c to
312ada7
Compare
aanm
approved these changes
Mar 5, 2025
There was a problem hiding this comment.
@joestringer do you think we could make this automated as part of step 4? 🤔
|
I like that idea yeah 👍 I'd have to integrate that as part of an upcoming release (to avoid breaking the release process for other release managers during patch release prep) |
|
Filed #305 to follow up on that idea. |
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 replaces the core implementation of bump-readme.sh with Go.
The new Go tool takes a versions.json input that has a list of release
versions and dates, as well as taking the README.rst on stdin, and it
substitutes the versions with the latest versions from the JSON file,
sending the output to stdout.
The bump-readme.sh script is now reduced in scope to remove most sed
usage, it now:
Documentation/_static/stable-version.json
Overall this should make the implementation more reliable in replacing
the relevant version / date fields, regardless of what the latest
versions are. It also significantly reduces the usage of sed, which
should generally bring this scripting closer to cross-platform
friendliness. Finally with more of the implementation in Go, if
something is wrong, the community is more likely to be able to dig into
why and propose a fix.
In future we can probably push this into the main release binary as a
step six so we can automate this piece in GHA, but for now I just
implemented it separately as an incremental step in the right direction.