Skip to content

Latest commit

 

History

History
73 lines (46 loc) · 1.59 KB

MAINTAINERS.md

File metadata and controls

73 lines (46 loc) · 1.59 KB

Maintainers

Pull Requests

When merging Pull Requests on GitHub, use the squash and merge button, so that our timeline of master branch is linear.

Releases

To publish a new release:

$ git checkout master
$ git pull origin master

$ npm run transpile
$ npm version patch(|minor|major)
$ npm publish
$ git push --follow-tags

Or via Makefile:

$ make release VERSION=patch

Changelogs

Changelogs are generated using the github_changelog_generator gem.

Make sure you have Ruby v2.2+:

$ gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3
$ curl -sSL https://get.rvm.io | bash -s stable

$ rvm install 2.2.2

Then install the gem:

$ gem install github_changelog_generator

Now you can generate CHANGELOG.md file automatically by running:

$ make changelog GITHUB_API_TOKEN="YOUR_GITHUB_TOKEN"

GitHub API Token

You can generate a token here

Since this is a public repository, you only need public_repo access for the token.

Pushing CHANGELOG.md

Once the CHANGELOG.md file is generated, it is up to you to commit and push it to GitHub.

There is a handy command available:

$ make push-changelog

Adding Release Note

After CHANGELOG.md is pushed to GitHub, release notes should be added.

In the repository navigate to release section. Here open the Tags tab and click on Edit button. Add your CHANGELOG.md notes in the editing section and save.