chore(release): v0.1.4

trigger release to test homebrew workflow

Author: Roytangrb

.github/workflows/release.yml

@@ -50,7 +50,8 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          upload_url: ${{ steps.create_release.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps 
+          # This pulls from the Create Release step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps 
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
           asset_path: ./gitwok-mac.tar.gz
           asset_name: gitwok-mac.tar.gz
           asset_content_type: application/x-gzip

CONTRIBUTING.md

@@ -4,6 +4,7 @@
 
 1. [Code of Conduct](#code-of-conduct)
 1. [Project setup](#project-setup)
+1. [Workflows](#workflows)
 1. [Testing](#testing)
 1. [Filing an issue](#filing-an-issue)
 1. [Contributing](#contributing)
@@ -33,6 +34,12 @@ First, fork and clone this repo to your local `$GOPATH/src/gitwok`
 1. `go build -mod=vendor` build with src from `./vendor` directory
 1. run the executable `./gitwok`
 
+## Workflows
+
+* `ci.yml`: this is the standard go CI workflow to run all tests, build and uploading test coverage report to `codecov.io`. The detailed report can be view [here](https://codecov.io/gh/Roytangrb/gitwok)
+
+* `release.yml`: the CD workflow is triggered whenever a tag starting with `v` is pushed. It builds the executable binary, tar zips and creates a release with the version tag. The zipped asset is uploaded as github release asset. And the corresponding Homebrew Fomula changes will be PR to another [Homebrew tap repo](https://github.com/Roytangrb/homebrew-gitwok).
+
 ## Testing
 
 One may use [`go-expect`](https://github.com/Netflix/go-expect) for creating test for terminal or console based programs.
@@ -45,4 +52,4 @@ Adding `Labels` to raised issues are also useful for identifying issue scope. Fo
 
 ## Contributing
 
-Go test and test coverage report are include in the [CI github workflow](https://github.com/Roytangrb/gitwok/tree/main/.github/workflows). While submiting a pull requeset, please add along your test if appropriate.
+While submiting a pull requeset, please add along your test if appropriate.