Skip to content

Automate versions used in Reference_Manual.md #1302

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Jun 11, 2025
Merged

Automate versions used in Reference_Manual.md #1302

merged 4 commits into from
Jun 11, 2025

Conversation

ihsandemir
Copy link
Collaborator

@ihsandemir ihsandemir commented Jun 4, 2025 •
edited
Loading

Automated the version numbers used in the reference manual. The project version will be used. Reference_Manual.md is auto generated file now. Do not do manual modifications.

@ihsandemir ihsandemir added this to the 5.4.0 milestone Jun 4, 2025
@ihsandemir ihsandemir self-assigned this Jun 4, 2025
yuce
yuce previously approved these changes Jun 4, 2025
View reviewed changes
@ihsandemir
Automated the version numbers used in the reference manual. The proje…
52dc44e 
…ct version will be used. `Reference_Manual.md` is auto generated file now. Do not do manual modifications.
@ihsandemir ihsandemir changed the title Updated project version to 5.4.0 Automate versions used in Reference_Manual.md Jun 4, 2025
@ihsandemir ihsandemir requested a review from yuce June 4, 2025 14:53
@ihsandemir ihsandemir mentioned this pull request Jun 4, 2025
Merged
yuce
yuce previously approved these changes Jun 5, 2025
View reviewed changes
@ihsandemir ihsandemir requested a review from JackPGreen June 5, 2025 09:46
zdehz
zdehz previously approved these changes Jun 5, 2025
View reviewed changes
JackPGreen
JackPGreen reviewed Jun 9, 2025
View reviewed changes
Reference_Manual.md
```sh
curl -Lo hazelcast-cpp-client-5.2.0.tar.gz https://github.com/hazelcast/hazelcast-cpp-client/archive/v5.2.0.tar.gz
tar xzf hazelcast-cpp-client-5.2.0.tar.gz
curl -Lo hazelcast-cpp-client-5.4.0.tar.gz https://github.com/hazelcast/hazelcast-cpp-client/archive/v5.4.0.tar.gz
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it make sense to include a link that doesn't work (until 5.4.0 is released)?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What else would you suggest? We can only refer to a development snapshot but that does not exist for C++ client. I could not come up with a better alternative. You can download the master zip during development and have it replace before every release with proper version but this will be also error prone.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What else would you suggest?

I don't know!

JackPGreen
JackPGreen reviewed Jun 9, 2025
View reviewed changes
Copy link
Contributor

@JackPGreen JackPGreen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do the instructions need to be updated to make it clear that after release build, a new Reference_Manual needs to be checked in? Trying to figure out the workflow.

@ihsandemir
Copy link
Collaborator Author

Do the instructions need to be updated to make it clear that after release build, a new Reference_Manual needs to be checked in? Trying to figure out the workflow.

No, it is not during the release (or after the release) time. It is during regular development when the Reference_Manual.md.in changes, we will commit the produced Reference_Manual.md into the repository.

@JackPGreen
Copy link
Contributor

Do the instructions need to be updated to make it clear that after release build, a new Reference_Manual needs to be checked in? Trying to figure out the workflow.

No, it is not during the release (or after the release) time. It is during regular development when the Reference_Manual.md.in changes, we will commit the produced Reference_Manual.md into the repository.

Maybe worth adding a comment under the version number to that effect for next time it's changed?

@ihsandemir ihsandemir dismissed stale reviews from zdehz and yuce via 4a3adb4 June 11, 2025 08:09
@ihsandemir
Copy link
Collaborator Author

No, it is not during the release (or after the release) time. It is during regular development when the Reference_Manual.md.in changes, we will commit the produced Reference_Manual.md into the repository.

Added the explanation in 4a3adb4 . how does it look?

@ihsandemir ihsandemir enabled auto-merge (squash) June 11, 2025 10:06
@ihsandemir ihsandemir merged commit 99d4587 into hazelcast:master Jun 11, 2025
46 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JackPGreen JackPGreen JackPGreen approved these changes

@yuce yuce yuce left review comments

@zdehz zdehz zdehz left review comments

@g-donev g-donev Awaiting requested review from g-donev

@oliverhowell oliverhowell Awaiting requested review from oliverhowell

Assignees

@ihsandemir ihsandemir

Labels
Type: Documentation
Projects
None yet
Milestone
5.4.0
Development

Successfully merging this pull request may close these issues.
4 participants
@ihsandemir @JackPGreen @yuce @zdehz