Skip to content

Commit

Permalink
docs: add Before run Shipjs section (#427)
Browse files Browse the repository at this point in the history
* docs: add Before run Shipjs section

* chore: remove .tool-versions
  • Loading branch information
tyankatsu0105 authored and Haroenv committed Nov 20, 2019
1 parent 4eec2b6 commit a528036
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

- [Installation](#installation)
- [Install `hub`](#install-hub)
- [Before run Shipjs](#before-run-shipjs)
- [Dry Mode](#dry-mode)
- [On your local machine](#on-your-local-machine)
- [Automate Part 3 (`shipjs trigger`) on your CI](#automate-part-3-shipjs-trigger-on-your-ci)
Expand Down Expand Up @@ -75,6 +76,24 @@ You can get an access token from [here](https://github.com/settings/tokens).
Or you can simply run `hub api user`, follow the instruction and it will generate the token and write the config file for you.
### Before run Shipjs
Shipjs compares previous version.
Before run `shipjs` commands, you need release first version by yourself.
Let's release first version with [yarn version](https://yarnpkg.com/en/docs/cli/version) commands.
In this situation, your branch is `master` and your package version is `0.0.0`.
You want to release `0.0.1` at `master` branch.
```bash
yarn version --patch
git push origin master
git push --tags
```
With this you can use `shipjs` commands.
### Dry Mode
If you're not sure, you can always run commands in dry mode.
Expand Down

0 comments on commit a528036

Please sign in to comment.