[GitHub] houshengbo commented on a change in pull request #366: Add docs for publishing tagged releases to brew

[GitBox <gi...@apache.org>]

houshengbo commented on a change in pull request #366: Add docs for publishing tagged releases to brew
URL: https://github.com/apache/incubator-openwhisk-cli/pull/366#discussion_r236426559
 
 

 ##########
 File path: CONTRIBUTING.md
 ##########
 @@ -80,3 +80,17 @@ Please provide information that helps the developer test any changes they make b
 ## Coding style guidelines
 
 Use idomatic go. Document exported functions.
+
+# Publishing Tagged Release to Homebrew
+
+ [Homebrew](https://brew.sh) is used to install `wsk` locally. Once we release a new version of `wsk` we should update its version in homebrew.
+
+ Get the new release SHA256 checksum by downloading the Source Code (tar.gz) from the [releases page](https://github.com/apache/incubator-openwhisk-cli/releases) and running `shasum -a 256 X.Y.Z.tar.gz` on the tarball.
+
+ Update brew formula with the automation command `brew bump-formula-pr`:
+ ```bash
+ $ brew bump-formula-pr \
+   --url='https://github.com/apache/incubator-openwhisk-cli/archive/X.Y.Z.tar.gz' \
 
 Review comment:
   Yes, please make sure what is the valid link, what the user should change in order to make the link work. My suggestion is to have a link with a certain format, and take a certain version as an example to provide a valid link. 
   
   Format: https://github.com/apache/incubator-openwhisk-cli/archive/<X.Y.Z.tar.gz>.
   Example for 0.9.0 is https://github.com/apache/incubator-openwhisk-cli/archive/0.9.0-incubating.tar.gz
   The user needs to give a valid link by changing the name of the the artifact.
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services