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

Support passing argument to toggle between stable and pre-release release notes #597

Closed
AdmiringWorm opened this issue Jul 31, 2020 · 4 comments · Fixed by #602
Closed
Assignees
Labels
Milestone

Comments

@AdmiringWorm
Copy link
Member

In the current stable release of cake.recipe release notes are always created using a MajorMinorPatch version, however, in the latest development version, it is created using a SemVer version instead.

Instead of having the ability to only use 1 or the other, I suggest adding support for a specific argument that can be passed when running the cake script to select whether semver or majorminorpatch version should be used for the milestone.

As an example:
Creating release notes without a specific argument, would use MajorMinorPatch as the default (to keep it backward compatible), but running the cake script with something along the lines of --create-pre-release would use a semantic version instead (ie 1.0.0-beta.1).

@AdmiringWorm AdmiringWorm added this to the 2.0.0 milestone Jul 31, 2020
@gep13
Copy link
Member

gep13 commented Jul 31, 2020

@AdmiringWorm this sounds like the correct path forward. Were you wanting to take a stab at this?

@AdmiringWorm
Copy link
Member Author

Were you wanting to take a stab at this?

Yeah, most likely, either during the weekend or sometime next week.
I didn't want to assign myself until I start working on it, as it should be quite simple to implement, and I want to allow other people the opportunity to add the feature if they wish to help out.

@gep13
Copy link
Member

gep13 commented Jul 31, 2020

@AdmiringWorm makes sense! Thanks

@AdmiringWorm AdmiringWorm self-assigned this Aug 3, 2020
@AdmiringWorm
Copy link
Member Author

I have started looking into this request now.

AdmiringWorm added a commit to AdmiringWorm/Cake.Recipe that referenced this issue Aug 3, 2020
…ase notes

This allows an argument called 'create-pre-release'
to be used when calling the cake build script for
specifically setting the milestone to the generated
SemVer version, instead of a stable version.
On tagged releases this should always be
the SemVer version no matter what is used.
gep13 pushed a commit to AdmiringWorm/Cake.Recipe that referenced this issue Aug 3, 2020
…ase notes

This allows an argument called 'create-pre-release'
to be used when calling the cake build script for
specifically setting the milestone to the generated
SemVer version, instead of a stable version.
On tagged releases this should always be
the SemVer version no matter what is used.
gep13 pushed a commit to AdmiringWorm/Cake.Recipe that referenced this issue Aug 3, 2020
…ase notes

This allows an argument called 'create-pre-release'
to be used when calling the cake build script for
specifically setting the milestone to the generated
SemVer version, instead of a stable version.
On tagged releases this should always be
the SemVer version no matter what is used.
@gep13 gep13 closed this as completed in #602 Aug 3, 2020
gep13 added a commit that referenced this issue Aug 3, 2020
(GH-597) Add ability to select pre-release or stable release notes
cake-contrib-bot pushed a commit that referenced this issue Aug 3, 2020
Merge pull request #602 from AdmiringWorm/feature/gh-597

(GH-597) Add ability to select pre-release or stable release notes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants