Add script to generate release announcments. - #281
Merged
Conversation
SamBarker
changed the title
Member
|
good idea, with the inclusion of collaborators lately it's crying out for a bit of consistency |
SamBarker
force-pushed
the
feat/blog-template
branch
from
September 6, 2026 21:53
30a429d to
5604772
Compare
bin/new-release-post.sh prompts for version, tag range, author, and date, then fetches the contributor list via the GitHub API and writes a ready-to-edit _posts/YYYY-MM-DD-release-X_Y_Z.md file. Assisted-by: Claude (Anthropic) Signed-off-by: Sam Barker <sam@quadrocket.co.uk>
Signed-off-by: Sam Barker <sam@quadrocket.co.uk>
SamBarker
force-pushed
the
feat/blog-template
branch
from
September 6, 2026 22:08
5604772 to
26cebee
Compare
SamBarker
enabled auto-merge
September 6, 2026 22:08
robobario
approved these changes
Sep 6, 2026
| fetch_contributors() { | ||
| # Emits lines of the form "- [login](html_url)", sorted, deduplicated. | ||
| local old_tag="$1" new_tag="$2" | ||
| local jq_filter='.commits[].author | select(. != null) | select(.type == "User") | "\(.login)\t\(.html_url)"' |
Member
There was a problem hiding this comment.
kroxy-robot is a user as far as github knows and shows up in the list
- [kroxylicious-robot](https://github.com/kroxylicious-robot)
|
|
||
| ask "Release version (e.g. 0.25.0)" VERSION | ||
| ask "Previous release tag (e.g. v0.24.0)" OLD_TAG | ||
| ask "New release tag or commit SHA (e.g. v0.25.0)" NEW_TAG |
Member
There was a problem hiding this comment.
the new tag won't exist yet, maybe we should make suggest ref more strongly, or let them hit enter to default to main HEAD?
| ask "Previous release tag (e.g. v0.24.0)" OLD_TAG | ||
| ask "New release tag or commit SHA (e.g. v0.25.0)" NEW_TAG | ||
| ask "Author name" AUTHOR | ||
| ask "Author GitHub handle (without @)" AUTHOR_HANDLE |
Member
There was a problem hiding this comment.
Suggested change
| ask "Author GitHub handle (without @)" AUTHOR_HANDLE | |
| ask "Author GitHub handle (without @)" AUTHOR_HANDLE "$(gh api user --jq '.login')" |
| ask "Release version (e.g. 0.25.0)" VERSION | ||
| ask "Previous release tag (e.g. v0.24.0)" OLD_TAG | ||
| ask "New release tag or commit SHA (e.g. v0.25.0)" NEW_TAG | ||
| ask "Author name" AUTHOR |
Member
There was a problem hiding this comment.
Suggested change
| ask "Author name" AUTHOR | |
| ask "Author name" AUTHOR "$(git config get user.name)" |
|
|
||
| ask "Release version (e.g. 0.25.0)" VERSION | ||
| ask "Previous release tag (e.g. v0.24.0)" OLD_TAG | ||
| ask "New release tag or commit SHA (e.g. v0.25.0)" NEW_TAG |
Member
There was a problem hiding this comment.
Suggested change
| ask "New release tag or commit SHA (e.g. v0.25.0)" NEW_TAG | |
| ask "New release tag or commit SHA (e.g. v0.25.0)" NEW_TAG main |
looks like this would work with the gh api call to get commits between old tag and latest main
| tags: [ "releases", "kroxylicious-proxy" ] | ||
| --- | ||
|
|
||
| # Kroxylicious ${VERSION}: <!-- TODO: one-line headline capturing the release theme --> |
Member
There was a problem hiding this comment.
this h1 makes the thing render very loudly in the blog list
Our existing ones launch into the XYZ has snapped into existence paragraph. The title already gets set up as h1 https://kroxylicious.io/blog/kroxylicious-proxy/releases/2026/07/03/release-0_22_0.html so I think we already get the SEO benefit from the title.
Member
|
doh, sorry didn't see the automerge set |
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
2 participants
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.
Summary
Adds
bin/new-release-post.sh, an interactive script that generates a Kroxylicious proxy release announcement blog post.What it does
Running
./bin/new-release-post.shprompts for:It then calls the GitHub API via
ghto fetch and inline the contributor list, and writes a ready-to-edit_posts/YYYY-MM-DD-release-X_Y_Z.mdwith all boilerplate filled in andTODOmarkers for the sections the author needs to write.Why a script rather than a template file
A template file in
_posts/has no Jekyll convention behind it and requires manual copying and renaming. A script handles filename date-stamping automatically, inlines the contributor list at generation time (removing any build-time dependency ongh), and is self-documenting via its prompts.Requirements
ghCLI installed and authenticated (gh auth status)If
ghis unavailable or the API call fails, the contributor section gets a visible<!-- TODO -->comment rather than silently producing an empty list.