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

Updated Changelog #82

Closed
wants to merge 1 commit into from
Closed

Updated Changelog #82

wants to merge 1 commit into from

Conversation

TomKimsey
Copy link
Collaborator

@alexjhawk I often want to make changes that dont warrant a new release. How do you feel about adding commits like this where the Version is not set in the changelog but the entry is started. I just want a way to keep up on the changelog and allow multiple devs to potentially contribute to a version release with the changelog being accurate.

DO NOT MERGE

@TomKimsey TomKimsey requested a review from alexjhawk November 7, 2023 17:08
@alexjhawk
Copy link
Collaborator

I like this concept, although we may be able to find a better filler for CHANGEME. It doesn't really matter what we use at the end of the day, because it should never be merged, therefore it should never affect the automation.

That being said, something like v1.15.6-next1 or v1.15.7-pre1 may fit better. We could stick with the existing version number and then use nextX to indicate active development of the next version on top of that, or we could bump the version number as appropriate and just include preX.

A more conventional approach would probably be to use a preX pattern. If a change is introduced that warrants a larger version number bump, I think that would be fine. I don't really have issues with 'pre' versions that don't have an associated official release, as long as the contained changes are in an 'official' release with the same/higher version number than the version number associated with the 'pre' build. I've seen plenty of examples of this in other Maven projects.

@TomKimsey
Copy link
Collaborator Author

I like this concept, although we may be able to find a better filler for CHANGEME. It doesn't really matter what we use at the end of the day, because it should never be merged, therefore it should never affect the automation.

That being said, something like v1.15.6-next1 or v1.15.7-pre1 may fit better. We could stick with the existing version number and then use nextX to indicate active development of the next version on top of that, or we could bump the version number as appropriate and just include preX.

A more conventional approach would probably be to use a preX pattern. If a change is introduced that warrants a larger version number bump, I think that would be fine. I don't really have issues with 'pre' versions that don't have an associated official release, as long as the contained changes are in an 'official' release with the same/higher version number than the version number associated with the 'pre' build. I've seen plenty of examples of this in other Maven projects.

I would like to avoid anticipating the version number since multiple developers could be working on changes at the same time and a new version is published before the change set that is updating the changelog gets approved.

I would be okay with something like vX.Y.Z as its pretty evident its not a version and it needs changing. Or vM.m.p , vMajor.Minor.Patch, v#.#.#

@TomKimsey TomKimsey closed this Nov 14, 2023
@TomKimsey TomKimsey deleted the THK_DELETE_ME branch November 14, 2023 19:31
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