No more manual work in your software releases.
Clone or download

README.md

Awesome


TL;DR Run npx automate-release πŸŽ‰.

A release might seem just an irrelevant number, but here you'll find why you should be using it.

Release software is part of our developer day, but we tend to run it manually just we remember it, being a source of errors.

Nowadays, we have the best tools to automate this task so let's use them.

Your next release will be automatically doing:

Let me show you how to do it.

Follow a Git Commit Convention

Tip: You can use a different convention configuration.

Using a git commit convention for our git messages help us all the messages of the contributors have a homogeneous appearance.

In addition, because we are going to use the same pattern for all the git messages, we can use that for do extra things, like for example, classify commits correctly at CHANGELOG.md or determinate what is the next version to release based on commit history.

For ensuring all git messages follow the same pattern, We are going to use commitlint for linting git messages.

It'll force you to follow a strict format into your git messages.

You can't do the commit until the format is valid.

(Actually, you could bypass this step using the --no-verify option, but avoid do that).

Commit Message Guidelines

Tip: Read more on Angular contribution guideline.

The git message must have a type. It could be:

  • build: Changes that affect the build system or external dependencies.
  • ci: Changes to our CI configuration files and scripts.
  • docs: Documentation only changes.
  • feat: A new feature.
  • fix: A bug fix.
  • perf: A code change that improves performance.
  • refactor: A code change that neither fixes a bug or adds a feature.
  • style: Changes that do not affect the meaning of the code.
  • test: Adding missing tests or correcting existing tests.

I know. really, I know.

The first time you use a convention for commits, you might think that it's over-engineering.

But, after use it a bit, it's very helpful, It makes easy read all the commits quickly or just focus in a determinate type of commits.

Examples of Git Commits

All the following examples are usual and valid:

build: update dependencies
ci: setup travis credentials
refactor: move scripts
fix: use user agent provided by parameters
test: update snapshots
style: use space instead of tabs

Determinate Next Version Based on History

Now that we have a git commit convention, we can jump in the next thing, that will make our first release πŸŽ‰.

For do that, we are going to use standard-version. After reading your git history and it will determinate what is the next release version.

standard-version will determinate automagically the next version to release based on your git history.

For do that it will consider:

patches (1.0.0 β†’ 1.0.1)

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

features (1.0.0 β†’ 1.1.0)

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

breaking changes (1.0.0 β†’ 2.0.0)

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

A release has some tasks associated:

  • πŸ‘‰ Increment the version at package.json.
  • πŸ‘‰ Generate a new entry in your CHANGELOG.md
  • πŸ‘‰ Create a new specific git commit for the released version.
  • πŸ‘‰ Create a new git tag with the version associated.

In addition, GitHub usernames (@kikobeats) and issue references (#133) will be swapped out for the appropriate URLs in your CHANGELOG.md.

A good practice is to put the command as npm run release script for performing the action.

{
  "scripts": {
    "release": "standard-version",
    "release:tags": "git push --follow-tags origin master",
    "postrelease": "npm run release:tags"
  }
}

As you can see, we associated push things into your master remote branch.

So, next time you want to do a release, just type npm run release (make sense, uh).

The first time you released a version, a CHANGELOG.md will be created. Otherwise, it will append just the new released version:

The CHANGELOG.md follows Keep a Changelog specification.

You can write into it and your words will be preserved between versions.

GitHub Release

GitHub (and GitLab too) has a special place into the repository for reflecting releases:

When you push a git tag, it will appear here, but nothing more. No text or changes associated.

Now that we are generating a CHANGELOG.md it would be interesting to reflect the changes associated with each version.

We can use a tool called [releaser-tools] (https://github.com/conventional-changelog/releaser-tools) who will do exactly that, leaving our release section pretty πŸ’….

Note: Remember to setup CONVENTIONAL_GITHUB_RELEASER_TOKEN. You can use direnv for declaring local development variables.

We need to associate it as part of our postrelease script:

{
  "scripts": {
  "postrelease": "npm run release:tags && npm run release:github",
  "release": "standard-version",
  "release:github": "conventional-github-releaser -p angular",
  "release:tags": "git push --follow-tags origin master"
  }
}

Next time, your metadata will be associated with the GitHub/GitLab release πŸŽ‰

Continous Release

The human behavior in a release process is very limited: we only have to trigger the release action. After that, all is automated πŸ€–.

But what if I say you we can eliminate the human behavior from the release equation?

The premise will be that, every commit on your master branch will mean that a new version of your software will be released.

Release on CI/CD

The right place to do this is as part of our Continuous Integration.

Every time a new Pull Request is merged in our master branch, our Tests will be executed to determinate if all is fine (nothing new here).

But now, after that, The Release stage will be executed, that will perform our npm run release command to complete the action.

Have you noticed that? It's the sweet sensation of automation.

That's specially helpful as maintainer if you are already have automated part of the process that uses services such as Greenkeeper to keep your dependencies up to date, that create PR very often if you have many dependencies or they are updated very often (something that happens all the time at NPM ecosystem).

You can see .travis.yml to see how it is done or just run npx automate-release to install it in your project folder.

Communicate Your Changes

You can establish a strategy for communicating your release change in every release to put the icing on the cake.

Just you need to recover the latest release and publish it on other channel using an intermediate service that connects it over Twitter, Slack or where your audience is

Retrieve the Latest Release

GitHub

  • GitHub API – For recovering information per owner_name/repo_name.
  • GitHub RSS Feed – For getting atom feed per owner_name/repo_name.

Publishing the Latest Release

Services

Self-Hosted
  • tom.js.org – A tiny microservice for sending notifications using multiple channels (Slack/Twitter/Telegram/Email).