Skip to content

Conversation

@JackPGreen
Copy link
Contributor

@JackPGreen JackPGreen commented Nov 6, 2025

Partially automates the steps listed in the C++ Client Release Process documentation.

Specifically, steps:

  • 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.

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:

  • update docs

Partially addresses: DI-669

_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 JackPGreen requested a review from nishaatr November 6, 2025 21:59
@JackPGreen JackPGreen changed the title Partially automate release - tagging and documentation generation Partially automate release - tagging and documentation generation [DI-669 Nov 6, 2025
@JackPGreen JackPGreen changed the title Partially automate release - tagging and documentation generation [DI-669 Partially automate release - tagging and documentation generation [DI-669] Nov 6, 2025
@JackPGreen JackPGreen self-assigned this Nov 6, 2025
@JackPGreen JackPGreen requested a review from nishaatr November 7, 2025 10:46
@nishaatr
Copy link
Contributor

nishaatr commented Nov 7, 2025

@JackPGreen
thanks for doing this
while we are at it lets automate Create branch at some point to make things little more easier. (I am sure you have considered this!)

@JackPGreen
Copy link
Contributor Author

JackPGreen commented Nov 7, 2025

@JackPGreen thanks for doing this while we are at it lets automate Create branch at some point to make things little more easier. (I am sure you have considered this!)

🧙
#1366

@JackPGreen JackPGreen requested a review from ldziedziul November 8, 2025 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants