Partially automate release - tagging and documentation generation [DI-669] #1362
Conversation
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
_Partially_ automates the steps in https://hazelcast.atlassian.net/wiki/spaces/HZC/pages/129810774/C+Client+Release+Process Specifically: - Git tagging - Doxygen By scripting and chaining the steps, the (manual) release work is reduced and consistency is improved. Tagging logic based on [approach in `hazelcast-docker`](https://github.com/hazelcast/hazelcast-docker/blob/master/.github/workflows/retag.yml). Of note - the instructions call for an "annotated tag" (`tag -a`). While this [seems more sensible](https://stackoverflow.com/q/4971746), it's not [how we make tags elsewhere](https://github.com/search?q=org%3Ahazelcast%20%22git%20tag%22&type=code) (most notablly - [in the release pipeline](https://github.com/hazelcast/hazelcast-pipeline-library/blob/43882a84b3715e2ac74f84c92f3c3d170504f2ab/src/com/hazelcast/qe/pipeline/git/Branch.groovy#L122-L127)), so for consistency I've changed to lightweight tags. Testing: - [example execution](https://github.com/JackPGreen/hazelcast-cpp-client/actions/runs/19150806835) - [tag created](https://github.com/JackPGreen/hazelcast-cpp-client/releases/tag/v5.5.3) - [documentation PR raised](#4) Post-merge actions: - [ ] update docs
JackPGreen
changed the title
JackPGreen
changed the title
nishaatr
requested changes
Nov 7, 2025
Contributor
|
@JackPGreen |
Contributor
Author
🧙 |
nishaatr
approved these changes
Nov 10, 2025
1 task
ldziedziul
approved these changes
Nov 14, 2025
ihsandemir
requested changes
Nov 14, 2025
Collaborator
ihsandemir
left a comment
ihsandemir
left a comment
There was a problem hiding this comment.
Is there a way you can test this workflow?
|
|
||
| # doc-index.html | ||
| sed -i \ | ||
| "/Development Branch/a\<li><a href=\"https://github.com/${GITHUB_REPOSITORY}/blob/${{ needs.prepare.outputs.tag_name }}/Reference_Manual.md\">${{ inputs.BRANCH_NAME }}</a></li>" \ |
Collaborator
There was a problem hiding this comment.
does this cause the development branch disappear?
Contributor
Author
There was a problem hiding this comment.
does this cause the development branch disappear?
No - it's simply using Development Branch as an anchor to insert the content below (assuming it goes at the top of the list, enough for now).
For validation - check the diff in the doc PR it generated.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Partially automates the steps listed in the
C++ Client Release Processdocumentation.Specifically, steps:
Git taggingDoxygenBy scripting and chaining the steps, the (manual) release work is reduced and consistency is improved. Tagging logic based on approach in
hazelcast-docker.Where possible, I've tried to replicate how it currently works. It's likely there's future scope to improve (e.g. should the documentation updates really raise a PR?).
Of note - the instructions call for an "annotated tag" (
tag -a). While this seems more sensible, it's not how we make tags elsewhere (most notably - in the release pipeline), so for consistency I've changed to lightweight tags.Testing (in my fork):
Post-merge actions:
Partially addresses: DI-669