Skip to content
This repository was archived by the owner on Jul 28, 2023. It is now read-only.

Commit 196bc34

Browse files
authored
Merge pull request #241 from kabanero-io/s1cyan-doc-update
Update build_help.md
2 parents 751a9f1 + e352f5e commit 196bc34

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

docs/build_help.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
# Installation
2-
## OSX, Windows, Linux
1+
# Build Guide
2+
3+
## Installation
4+
### OSX, Windows, Linux
35
You can download the binary `kabanero` command from here:
46
https://github.com/kabanero-io/kabanero-command-line/releases
57

68

7-
# Generating the README.md
9+
## Generating the README.md
810
The project uses Cobra's built in mechanism to generate the CLI README.md. Run the following command to generate the README:
911
` ./build/kabanero docs --docFile ./README.md`
1012

11-
# Building from Source
1213

1314
## Travis build
1415
The project is instrumented with Travis CI and with an appropriate `Makefile`. Most of the build logic is triggered from within the `Makefile`.
@@ -19,7 +20,17 @@ Upon commit, only the `test` and `lint` actions are executed by Travis.
1920

2021
In order for Travis to go all the way to `package` and `deploy`, you need to create a *new* release on Github(one that is tagged with a never seen before tag). When you create a new release, a Travis build will automatically run, and the resulting artifacts will be posted on the `Releases` page. With each new release or release candidate don't forget to indicate on the "This is a pre-release" tick box. Update notable changes in the comments section from the last release (check the commits from now to last release).
2122

22-
## Manual build
23+
## Updating the brew install for new releases
24+
25+
The homebrew repository for Kabanero CLI: https://github.com/kabanero-io/homebrew-kabanero
26+
27+
This brew install method is similar to what the Appsody team did for the Appsody CLI. You just have to update the `url` and `sha` fields.
28+
29+
`url`: This will be the url for the homebrew tar that gets generated from the travis build for a new release.
30+
31+
`sha`: Download the homebrew tar locally and calculate the sha256 for it. You can use the command: `shasum -a 256 <homebrew_tar>`
32+
33+
## Building the CLI manually
2334
You can also test the build process manually.
2435

2536

@@ -53,3 +64,5 @@ Here's a description of the various artifacts as you would see them in a release
5364

5465
### Running the CLI
5566
`./kabanero`
67+
68+

0 commit comments

Comments
 (0)