Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
48 lines (35 loc) · 1.39 KB

DEVELOPMENT.md

File metadata and controls

48 lines (35 loc) · 1.39 KB

For contributers

Before you commit

  • Create your branch from master branch. And your pull requests should head to master branch in general.
  • Run npm run build to build dist/* and commit them. They are not .gitignored.

For repository owners

Release procedure

0. Requirements

1. Create new tag

Be sure your local master branch is up-to-date.

  1. Create a release branch from master branch.
    1. git switch master && git pull
    2. git switch -c <BRANCH_NAME>
  2. Update the change log.
    1. VERSION=<TAG> npm run changelog
  3. Update versions in package.json and package-lock.json.
    1. Manually 😜
  4. Commit and push. Create a pull request.
    1. git commit -m "<TAG>"
    2. git push
    3. Create a pull request in your favourite way.
  5. After the PR is merged, add new tag to the HEAD of master branch.
    1. git switch master && git pull
    2. git tag <TAG>
    3. git push origin <TAG>

2. Publish to npm

  1. npm login
    1. Be sure you are logging in to the nulab account.
  2. npm publish --dry-run
  3. npm publish
  4. npm logout

3. Create a release in GitHub

  1. Push Draft a new release button in https://github.com/nulab/backlog-js/releases .
  2. Paste a URL which links to the CHANGELOG.md.
    1. e.g. https://github.com/nulab/backlog-js/blob/master/CHANGELOG.md#0120-2021-01-08