Skip to content

Commit

Permalink
add release steps to readme (#156)
Browse files Browse the repository at this point in the history
  • Loading branch information
jennypollack authored and estebanmino committed Oct 14, 2019
1 parent 91ba737 commit e396789
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,19 @@ Linking GABA into other projects involves a special NPM command to ensure that d
$ npm link gaba
```

## Release Steps

- Create branch from `develop` named `v${version}`
- push remote branch
- Run `npx release <major|minor|patch>`. `major` for breaking changes, `patch` for bugfixes, `minor` for backwards compatible features.
- Then select which PRs will be added to generate the changelog
- Github page will be opened in your browser with the new generated tag and changelog, press the green button to release.
- Then merge `v${version}` branch to `develop`, then make `master` up to date with `develop`
- enable "create merge commit" option
- do a normal merge to maintain history
- disable "create merge commit" option
- On a clean `master` run `npm run build` go to `/dist` folder just generated, then `npm publish` and GABA will be on npm

## API documentation

API documentation is auto-generated for the GABA package on every commit to the `master` branch.
Expand Down

0 comments on commit e396789

Please sign in to comment.