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

Don't recommend initial use of intentionally-skip #119

Merged
merged 1 commit into from
Dec 5, 2023

Conversation

mcmire
Copy link
Contributor

@mcmire mcmire commented Dec 5, 2023

Currently we say in the releas spec that if the user wants to skip a package, they can specify "intentionally-skip" in place of the version. We actually don't want first-time users to know about this directive up front, because it suppresses errors that would ordinarily be produced if you omit a package from the release that you shouldn't. Rather, we want to only suggest this in the error message.

Hence, this commit removes the reference to "intentionally-skip" from the release spec. It also adds some more instructions for first-time users.

Currently we say in the releas spec that if the user wants to skip a
package, they can specify "intentionally-skip" in place of the version.
We actually don't want first-time users to know about this directive up
front, because it suppresses errors that would ordinarily be produced if
you omit a package from the release that you shouldn't. Rather, we want
to only suggest this in the error message.

Hence, this commit removes the reference to "intentionally-skip" from
the release spec. It also adds some more instructions for first-time
users.
@mcmire mcmire requested a review from a team as a code owner December 5, 2023 21:34
Copy link
Contributor

@cryptodev-2s cryptodev-2s left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@mcmire mcmire mentioned this pull request Dec 5, 2023
@mcmire mcmire merged commit 95bf176 into main Dec 5, 2023
16 checks passed
@mcmire mcmire deleted the remove-reference-to-intentionally-skip branch December 5, 2023 21:57
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