"prerelease" keyword supported in bump and get (issue #51) #69
Conversation
README.md
Outdated
| @@ -45,10 +45,10 @@ usage | |||
|
|
|||
| ``` | |||
| Usage: | |||
| semver bump (major|minor|patch|release|prerel [<prerel>]|build <build>) <version> | |||
| semver bump (major|minor|patch|release|prerel|prerelease [<prerel>]|build <build>) <version> | |||
There was a problem hiding this comment.
| semver bump (major|minor|patch|release|prerel|prerelease [<prerel>]|build <build>) <version> | |
| semver bump (major|minor|patch|release|prerel [<prerel>]|prerelease [<prerel>]|build <build>) <version> |
The prerel sub-command also supports an argument. I believe it's time to start breaking this single line into multiple lines.
semver bump major <version>
semver bump minor <version>
...
semver bump prerel [<prerel>] <version>
This should improve readability.
There was a problem hiding this comment.
Agreed. Will break up this command. Try to make clear that the sub-commands "prerel" and "prerelease" are identical (just synonyms).
| "bump release" removes any PRERELEASE or BUILD parts. | ||
| subsequent parts. "bump prerel" (or its synonym "bump prerelease") | ||
| sets the PRERELEASE part and removes any BUILD part. A trailing dot | ||
| in the <prerel> argument introduces an incrementing numeric field |
There was a problem hiding this comment.
Is the prerel argument mandatory? If so, the usage should reflect that (remove the square bracket).
There was a problem hiding this comment.
The argument to "prerel"/"prerelease" is indeed optional.
The "diff" subcommand returns the keyword "prerelease" when it
is the pre-release part that differs. This keyword--different from
"prerel"--means using the output of "diff" is awkward to use as
input to "bump" or "get". This change creates a synonym for "prerel",
namely "prerelease" in the bump and get subcommands, fixing the
output/input awkwardness without breaking backwards compatibility.
The implementation is simple: normalize the part keyword to a
canonical string ("prerel"). This is completely transparent to
the external API.
The README and usage string have been updated accordingly.
The README and usage string now list each subcommand on a separate
line for readability: the previous list of subcommand choices being
too long.
The order of the subcommands listed has been changed: the two
"complex" subcommands ("bump" and "get") appear ahead of the
others.
The changes pass all the existing unit tests: no regression or
backward compatibility issues. Two new test cases added to cover
use of this alternative keyword.
When released, these changes require bumping semver's minor version.
As a placeholder, the version string has been set to 3.4.0.
|
Rebased and squashed PR to address the comments raised above. When the PR is accepted, it should be tagged 3.4.0 and released. |
|
Since we've had a bit of new activity on this project lately (including a new PR), I'll take this opportunity to remind our owner that this PR has been ready to go for quite some time and the concerns in the comments above have been addressed. Ready to merge? (I'd do it myself, but I don't like accepting my own work). |
|
@ranger6, I trust your judgement to merge your own (and others!) PRs. Woud you like that we move the repository to a non-personal organisation where you could be owner? |
|
Thanks for the vote of confidence (and merging the PR).
I’m willing to co-own this project to make sure that it always has a maintainer and keeps evolving in a sane manner. So, if you were ever to step back or get hit by a snowplow, life at semver would go on. If you want to move the project as suggested, fine. On the other hand, things work pretty well as they are and I’ve got no ego involvement in ownership.
— ranger6
… On 12 Oct 2022, at 14:14, François Saint-Jacques ***@***.***> wrote:
@ranger6 <https://github.com/ranger6>, I trust your judgement to merge your own (and others!) PRs. Woud you like that we move the repository to a non-personal organisation where you could be owner?
—
Reply to this email directly, view it on GitHub <#69 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AA2YZ6JANJM7GPT6JDRZIR3WC2TRXANCNFSM5WMJN7XQ>.
You are receiving this because you were mentioned.
|
The "diff" subcommand returns the keyword "prerelease" when it
is the pre-release part that differs. This keyword--different from
"prerel"--means using the output of "diff" is awkward to use as
input to "bump" or "get". This change creates a synonym for "prerel",
namely "prerelease" in the bump and get subcommands, fixing the
output/input awkwardness without breaking backwards compatibility.
The implementation is simple: normalize the part keyword to a
canonical string ("prerel"). This is completely transparent to
the external API.
The usage string and README have been updated accordingly.
The changes pass all the existing unit tests: no regression or
backward compatibility issues. Two new test cases added to cover
use of this alternative keyword.
When released, these changes require bumping semver's minor version.
As a placeholder, the version string has been set to 3.4.0.