fix: update release URL returned from publish.js #185
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@gr2m One more small PR for you, when you have time 🙂 |
Hmm, I don't think there is an obvious answer here, but I'd say it's a fix, because the intention was always to link to the release, and this change implements the intended behavior. Plus I don't think the change would be disruptive to any potential dependents |
|
🎉 This PR is included in version 6.0.8 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
I noticed this while putting together #184 and thought I'd open a separate issue to discuss.
What does this PR do?
Updates the return value of
publish.jsto return a web URL to the release instead of the tag. This is more consistent withsemantic-release/github: https://github.com/semantic-release/github/blob/81847f1abd1c9714e28a17f712739ffebb586bec/lib/publish.js#L101Here's an example of what a "tag" page looks like: https://gitlab.com/gitlab-org/gitlab/-/tags/v13.6.0-ee
And here's an example of its corresponding "release" page: https://gitlab.com/gitlab-org/gitlab/-/releases/v13.6.0-ee
The later is a nicer representation of the release, and we may be removing release notes from the former in the future: https://gitlab.com/gitlab-org/gitlab/-/issues/292279.
Question
I looked through the plugin authoring docs, but I wasn't able to find how this return value is actually used. As a result, I'm not exactly sure what kind of change this is (
fix,feat, or maybe evenBREAKING CHANGE?).