Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add Before run Shipjs section #427

Merged
merged 2 commits into from
Nov 20, 2019
Merged

docs: add Before run Shipjs section #427

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
25f2fde
docs: add Before run Shipjs section
tyankatsu0105 Nov 20, 2019
53f9eea
chore: remove .tool-versions
tyankatsu0105 Nov 20, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions GUIDE.md
View file
Open in desktop
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