rzamana/standard-version

Library that helps with generating CHANGELOG.md and versioning

Standard Version

, _(*1)

This is a PHP composer library fork based on the npm standard-version!, _(*2)

Automatic versioning and CHANGELOG generation, using GitHub's squash button and conventional commit messages., _(*3)

how it works:, _(*4)

1. when you land commits on your master branch, select the Squash and Merge option.
2. add a title and body that follows the Conventional Commits Specification.
3. when you're ready to release:
   1. git checkout master; git pull origin master
   2. run standard-version
   3. git push --follow-tags origin master && npm publish

standard-version does the following:, _(*5)

1. bumps the version in _composer.json_ (based on your commit history)
2. update CHANGELOG.md
3. commits composer.json (et al.) and CHANGELOG.md
4. tags a new release

Installation

Under construction, _(*6)

Commit Message Convention, at a Glance

patches:, _(*7)

git commit -a -m "fix(parsing): fixed a bug in our parser"

features:, _(*8)

git commit -a -m "feat(parser): we now have a parser \o/"

breaking changes:, _(*9)

git commit -a -m "feat(new-parser): introduces a new parsing library
BREAKING CHANGE: new library does not support foo-construct"

other changes:, _(*10)

You decide, e.g., docs, chore, etc., _(*11)

git commit -a -m "docs: fixed up the docs a bit"

but wait, there's more!, _(*12)

Github usernames (@bcoe) and issue references (#133) will be swapped out for the appropriate URLs in your CHANGELOG., _(*13)

FAQ

Under Construction, _(*14)

License

ISC, _(*15)