Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
All new code requires tests to ensure against regressions
Description of the Change
Publishing doc tweaks:
Adds a v to the publish message; from Prepare 1.12.0 release to Prepare v1.12.0 release
Expands the description of the --tag flag to specify v is required.
Alternate Designs
Could remove the Must be of the form vx.y.z message from the inline flag description, as it's also stated in the block of text, but I feel it's easier not to miss if it's also there.
Benefits
Make required steps clearer.
Possible Drawbacks
none
Verification Process
Tested npm version minor -m "Prepare v%s release" on a dummy package; the git commit message was Prepare v0.38.0 release as expected.
The doc changes were verified by running apm help publish.
as-cii
commented
5 years ago
Requirements
Description of the Change
Publishing doc tweaks:
vto the publish message; fromPrepare 1.12.0 releasetoPrepare v1.12.0 release--tagflag to specifyvis required.Alternate Designs
Could remove the
Must be of the form vx.y.zmessage from the inline flag description, as it's also stated in the block of text, but I feel it's easier not to miss if it's also there.Benefits
Make required steps clearer.
Possible Drawbacks
none
Verification Process
Tested
npm version minor -m "Prepare v%s release"on a dummy package; the git commit message wasPrepare v0.38.0 releaseas expected.The doc changes were verified by running
apm help publish.Applicable Issues
closes #724 also addresses https://github.com/atom/atom.io/issues/118#issuecomment-301992922