Skip to content
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

Fix version number displayed on startup #118

Merged
merged 1 commit into from
Jun 12, 2024
Merged

Conversation

lukasz-antoniak
Copy link
Contributor

No description provided.

Copy link
Collaborator

@alicel alicel left a comment

Choose a reason for hiding this comment

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

Looks fine to me, just left a few comments to add some missing articles in the markdown file.

@@ -36,13 +36,12 @@ The result of that workflow is the creation and publishing of a Docker image wit

### Create an official `Release` in GitHub

Once the tag has been pushed to the repository and the build has been verified, a `Release` should be created within GitHub matching the tag. This is a manual step that must be completed after the automation.
Once the tag has been pushed to the repository and the build process completed, new `Release` will be created automatically within GitHub matching the tag. Manual step is required to update release notes.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Minor rewording to add some missing articles:
Once the tag has been pushed to the repository and the build process completed, new Release will be created... --> Once the tag has been pushed to the repository and the build process completed, a new Release will be created...
Manual step is required to update release notes --> A manual step is required to update the release notes

4. Paste the contents of the `RELEASE_NOTES` relevant to this release into text-area for `Describe the release`.
5. Click the `Publish release` button.
1. Navigate in a browser to [https://github.com/datastax/zdm-proxy/releases](https://github.com/datastax/zdm-proxy/releases).
2. Search for release matching new tag name and edit it.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Search for release matching new tag name and edit it. --> Search for the release matching the new tag name and edit it.

5. Click the `Publish release` button.
1. Navigate in a browser to [https://github.com/datastax/zdm-proxy/releases](https://github.com/datastax/zdm-proxy/releases).
2. Search for release matching new tag name and edit it.
3. Paste the contents of the `RELEASE_NOTES` relevant to this release into text-area for `Describe the release`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

into text-area--> into the text area

Copy link
Collaborator

@alicel alicel left a comment

Choose a reason for hiding this comment

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

Looks great, thanks! +1 also to adding a note to remember to update the hardcoded ZDM version - this is a very useful reminder until we have a better way to manage this.

@lukasz-antoniak lukasz-antoniak merged commit a6a5fc1 into main Jun 12, 2024
7 of 8 checks passed
@lukasz-antoniak lukasz-antoniak deleted the version-fix branch June 12, 2024 10:40
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