docs: add description for GitHub release (#331)

* docs: add description for GitHub release * docs: fix typo Co-Authored-By: Eunjae Lee <[email protected]>
algolia · Oct 14, 2019 · 78def8d · 78def8d
1 parent f1e4e77
commit 78def8d
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -24,6 +24,7 @@ When releasing, you go through something like the following:
 - Update the changelog
 - Actually release it (e.g. `yarn build && yarn publish`)
 - Create a git tag
+- Create a release on GitHub
 
 ### What could go wrong?
 
@@ -67,6 +68,7 @@ Run `shipjs trigger` and it will briefly do the following:
 - Run a final test (unit, e2e, etc).
 - Release it to NPM (or elsewhere as you configure it).
 - Create a git tag for the version.
+- Create a release for the tag on GitHub.
 
 You can manually run `shipjs trigger` on the base branch after the PR is merged.
 
@@ -113,8 +115,10 @@ If the conditions are met, `shipjs trigger` will briefly do the following:
 
 - Send a Slack message to notify the beginning of the release(If configured).
 - Run test, build and release it.
-- `git tag v1.0.1`
-- Push them to git remote and notify at Slack.
+- `git tag v1.0.1`.
+- Push them to git remote.
+- `hub release create -m <changelog> v1.0.1`
+- Notify at Slack.
 
 You can run `shipjs trigger --dry-run` just to see what will be executed without actual execution.