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

IsPreRelease discussion #58

Closed
Jericho opened this issue Jul 17, 2019 · 3 comments
Closed

IsPreRelease discussion #58

Jericho opened this issue Jul 17, 2019 · 3 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@Jericho
Copy link
Member

Jericho commented Jul 17, 2019

Currently, an addin is deemed to be 'prerelease' if it's explicitly marked as such in the nuspec OR it references another nuget package that is marked as prerelease.

The reason for this logic is because Wyam will not properly generate an addin's documentation if we don't mark it as prerelease in the YAML file we generate.

However, as @AdmiringWorm recently pointed out, this logic causes addins such as Cake.Graph to be excluded from the "Update Cake.Recipe" logic because they reference a prerelease package.

I would like to open the discussion: is this the desired behavior?

As far as updating Cake.Recipe, we probably want to exclude package that are explicitly marked as prerelease, but we probably don't want to exclude packages that are deemed prereleased because the reference another package which happens to be prerelease.

@gep13 can you chime in this discussion?

@Jericho Jericho added the question Further information is requested label Jul 17, 2019
@Jericho Jericho self-assigned this Jul 17, 2019
@AdmiringWorm
Copy link
Member

In my opinion, I don't think it is correct to exclude a addin just because it references a pre-release package.

I am not sure if excluding pre-release packages is correct at all.
If we take this with a little grain of salt, excluding pre-release packages effectively means to exclude unstable releases.
Now, if we are thinking in the path of Semver 2.0, then that means that any release that is in the range of 0.x should also be excluded (after all, all software that have not yet hit the 1.0 release should in theory be thought of unstable releases, or not entirely production ready).

However, in the context of Cake.Recipe. It would make sense to exclude releases of an addin marked as a pre-release, but IMO not just because they reference a package using a pre-release tag.

@Jericho
Copy link
Member Author

Jericho commented Jul 21, 2019

I'm in agreement that only packages specifically marked as prerelease should be excluded from Cake.Recipe but the current logic must remain in place as far as YAML files generation is concerned.

@Jericho Jericho added this to the 3.21.0 milestone Jul 22, 2019
@Jericho Jericho added enhancement New feature or request and removed question Further information is requested labels Jul 22, 2019
@Jericho
Copy link
Member Author

Jericho commented Jul 22, 2019

3.21.0 has been released and Cake.Graph is now properly considered compatible with Cake 0.33.0

@Jericho Jericho closed this as completed Jul 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants