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

Commit

Permalink
Merge pull request #163 from s1cyan/docs
Browse files Browse the repository at this point in the history
doc update for making a release
  • Loading branch information
tseelbach authored Jan 10, 2020
2 parents 3018fcf + abe28e4 commit 79e4dc7
Showing 1 changed file with 11 additions and 15 deletions.
26 changes: 11 additions & 15 deletions docs/build-help.md → docs/build_help.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Installation
## Mac OSX
## OSX, Windows, Linux
You can download the binary `kabanero` command from here:
https://github.com/kabanero-io/kabanero-command-line/releases


# Generating the README.md
The project uses Cobra's built in mechanism to generate the CLI README.md. Run the following command to generate the README:
` ./build/kabanero docs --docFile ./README.md`
Expand All @@ -14,44 +15,39 @@ The project is instrumented with Travis CI and with an appropriate `Makefile`. M

Upon commit, only the `test` and `lint` actions are executed by Travis.

In order for Travis to go all the way to `package` and `deploy`, you need to create a *new* release (one that is tagged with a never seen before tag). When you create a new release, a Travis build with automatically run, and the resulting artifacts will be posted on the `Releases` page.
## Creating a new release

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).

## Manual build
You can also test the build process manually.


Prerequisites:

* docker is installed and running
* wget is installed

After setting the `GOPATH` env var correctly, just run `make <action...>` from the command line, within the same directory where `Makefile` resides. For example `make package clean` will run the `package` and then the `clean` actions.

The version number in manual builds default to 0.1.0. To change the value yourself change the `VERSION` value in the `Makefile`.


Some of the scripts have conditional paths, because certain Linux commands behave differently on OS/X and elsewhere (fun).

### What gets produced by the build?
Quite a bit of stuff.

Here's a description of the various artifacts as you would see them in a release page:

* The actual RPM package for RHEL/Centos (to be `yum`med or `rpm -i`)

* The binaries tarred up in the way homebrew loves them

* The plain binaries tarred up as they come out of the build process

** for OS/X

* The binary to run
* The tarball for the brew install

** for Linux

** for Windows
* The binary to run

* The homebrew Formula (which we should push to some git repo, once we go "public")
** for Windows

* The Debian package for Ubuntu-like Linux (to be `apt-get install`ed)
* The windows .exe to run

* Some other stuff that's always there

Expand Down

0 comments on commit 79e4dc7

Please sign in to comment.