please-release-me

Please release me, let me go,

For I don't love you any more...

• What is it?
• What does it do?
• What doesn't it do?
• How do I install it?
• How do I use it?
• What license is it released under?

What is it?

An automated release script for npm, Rust and Python, built to work with the conventions used by my packages. If you're not me, there's a good chance it won't work for you.

What does it do?

Performs sanity checks, bumps the version number, updates the change log and creates a new git tag.

Specifically, it runs through each of the following steps in order:

1. If it looks like there is a lint command in package.json, execute the command npm run lint. If the lint command fails, the release is aborted.

2. If it looks like there is a test command in package.json, execute the command npm t. If the test command fails, the release is aborted.

3. If it looks like there is a minify command in package.json, execute the command npm run minify. If the minify command fails, the release is aborted.

4. If Cargo.toml exists, execute the command cargo t. If it fails, the release is aborted.

5. Generate a list of commits made since the last tag.

6. Based on the commits from 5, bump the version string like so:

   • If any commit message begins with break: or breaking:, increment the major version.

   • Otherwise, if any commit message begins with feat: or feature:, increment the minor version.

   • Otherwise, increment the patch number.

7. If bower.json exists, write the freshly bumped version string to bower.json.

8. If component.json exists, write the freshly bumped version string to component.json.

9. If npm-shrinkwrap.json exists, write the freshly bumped version string to npm-shrinkwrap.json.

10. If package.json exists, write the freshly bumped version string to package.json.

11. If package-lock.json exists, write the freshly bumped version string to package-lock.json.

12. If setup.py exists, write the freshly bumped version string to setup.py.

13. If Cargo.toml exists, write the freshly bumped version string to Cargo.toml.

14. If Cargo.lock exists, write the freshly bumped version string to Cargo.lock.

15. If a change log is detected, write a summary of the changes to the change log. It will recognise any of the following file names:

    • CHANGELOG.md

    • CHANGELOG.txt

    • CHANGELOG

    • CHANGES.md

    • CHANGES.txt

    • CHANGES

    • HISTORY.md

    • HISTORY.txt

    • HISTORY

16. Commit all changes made by the preceding steps.

17. If Cargo.toml exists, execute the command cargo package. If it fails, the release is aborted.

18. Tag the release with the freshly bumped version string.

What doesn't it do?

• git push

• npm publish

• python setup.py sdist upload

• twine upload

• cargo publish

How do I install it?

npm i -g please-release-me

How do I use it?

Just run the command release, with no arguments:

release

What license is it released under?

MIT.