Skip to content
This repository was archived by the owner on Mar 1, 2021. It is now read-only.

Update Cake.DotNetTool.Module to target Cake v1.0.0 #23

Closed
augustoproiete opened this issue Feb 8, 2021 · 10 comments · Fixed by #24
Closed

Update Cake.DotNetTool.Module to target Cake v1.0.0 #23

augustoproiete opened this issue Feb 8, 2021 · 10 comments · Fixed by #24
Assignees
Milestone

Comments

@augustoproiete
Copy link
Member

augustoproiete commented Feb 8, 2021

https://cakebuild.net/blog/2021/02/cake-v1.0.0-released

@gep13
Copy link
Member

gep13 commented Feb 9, 2021

@augustoproiete @nils-a should this be a breaking change?

Also, can this be assigned a milestone so that it isn't lost when it comes to creating release notes?

@augustoproiete augustoproiete added this to the 0.5.0 milestone Feb 9, 2021
@augustoproiete
Copy link
Member Author

augustoproiete commented Feb 9, 2021

@gep13 Yes, I think it's safer to assume all bumps of Cake.Core/Cake.Common to be breaking. I assigned it the label "Improvement" for the release notes (I believe the process today only allows for 1 label per issue - correct if I'm wrong).

Associated with milestone 0.5.0 - minor bump on 0.x release seems to be the pattern historically, but we could go 1.0.0 across the board.

@gep13
Copy link
Member

gep13 commented Feb 9, 2021

@augustoproiete correct, currently only a single label can be assigned to an issue/PR, for it to make it into the release notes. As such, we should select the "worst" label to assign to an issue. If we agree that this is a breaking change, which will require changes by anyone pulling into a new update, we should assign this the breaking change label.

Thoughts?

I have no objections to going to a 1.0.0 release, although there is at least one issue that we should also tackle prior to this happening.

@augustoproiete
Copy link
Member Author

augustoproiete commented Feb 9, 2021

Happy to go either way.

Re: Label, I'm probably splitting hairs here but I see this issue as an improvement (Add support for Cake v1.0) and the release itself as breaking - i.e. We don't actually have a breaking feature to list in the release notes, as everything continues to work as before in terms of the DotNetTool.Module API. If this sentence is correct, then a bump to 0.5.0 should be enough to signal it is a breaking release.

The last time a similar breaking bump to Cake.Core happened it was classified as improvement (0.30 -> 0.33) https://github.com/cake-contrib/Cake.DotNetTool.Module/releases/tag/0.2.0 so wouldn't be a first (though doesn't mean it was correct then 😄).

What is the issue that would need to be completed before a 1.0.0 release? If it's complex, then I'd suggest shipping this as 0.5.0 asap, to unblock users migrating to Cake v1.0.0 and do the 1.0.0 later after tackling the issue you're thinking of.

@gep13
Copy link
Member

gep13 commented Feb 9, 2021

@augustoproiete said...
The last time a similar breaking bump to Cake.Core happened it was classified as improvement (0.30 -> 0.33) https://github.com/cake-contrib/Cake.DotNetTool.Module/releases/tag/0.2.0 so wouldn't be a first (though doesn't mean it was correct then 😄).

Yip, this was an omission on my part, and why I brought it up here 😄 Breaking change makes sense to me.

The issue I was referring to was this one: #18 and also, I don't seem to see an issue, but @devlead mentioned that there was another thing that needed to get done, to ensure correct handling of specific versions of .NET Tools. @devlead do you remember?

@augustoproiete
Copy link
Member Author

Sounds good. I swapped the labels.

#18 seems like an important one to get out the door though I'd put it on the complex category IMO... I'd vote for a 0.5.0 release today/asap just to have this working with Cake 1.0, and tackle #18 + the other issue @devlead may remember soon

@nils-a
Copy link

nils-a commented Feb 9, 2021

Seems you resolved everything while I started my day 😄
I added "breaking change" to the issues I created and bumped the major for releases.
So, to have my opinion on record: I feel breaking change is the "correct" label and I feel breaking changes warrant a bump of the major version.

@devlead
Copy link
Member

devlead commented Feb 9, 2021

@gep13 Actually don't remember what the additional thing was now, maybe it was upgrade / downgrade, but that's sorted right?

@gep13
Copy link
Member

gep13 commented Feb 9, 2021

@devlead honestly... I don't remember 😢

@gep13 gep13 modified the milestones: 0.5.0, 1.0.0 Feb 19, 2021
gep13 added a commit that referenced this issue Feb 20, 2021
* release/1.0.0:
  (maint) Turn off generation of docs
  (GH-34) Cross compile for .NET 5
  (GH-36) Add CodeQL Analysis workflow
  (GH-38) Workflow for forcing publish of docs
  (GH-37) Workflow for checking cake dependencies
  (GH-35) Add Dependabot configuration
  (GH-23): Update Cake.DotNetTool.Module to target Cake v1.0.0
@cake-contrib-bot
Copy link

🎉 This issue has been resolved in version 1.0.0 🎉

The release is available on:

Your GitReleaseManager bot 📦🚀

devlead pushed a commit to devlead/cake that referenced this issue Feb 27, 2021
augustoproiete added a commit to devlead/cake that referenced this issue Feb 27, 2021
devlead pushed a commit to devlead/cake that referenced this issue Feb 27, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
5 participants