-
Notifications
You must be signed in to change notification settings - Fork 51
Partially automate release - tagging and documentation generation [DI-669] #1362
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
JackPGreen
wants to merge
3
commits into
hazelcast:master
Choose a base branch
from
JackPGreen:partial-release-automation
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Partially automate release - tagging and documentation generation [DI-669] #1362
JackPGreen
wants to merge
3
commits into
hazelcast:master
from
JackPGreen:partial-release-automation
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
nishaatr
requested changes
Nov 7, 2025
Contributor
|
@JackPGreen |
Contributor
Author
🧙 |
nishaatr
approved these changes
Nov 10, 2025
1 task
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.
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