feat(changelog): add docker usage to changelog

2019-08-31 17:05:10 +02:00
parent 829f2925ab
commit 8643656339
11 changed files with 257 additions and 74 deletions
--- a/README.md
+++ b/README.md
@@ -2,24 +2,178 @@

 ## Release Types

-| Type      | Git tag               | Changelog             | Release           |  Write access git | Api token           |
-|---        |:---:                  |:---:                  |:---:              |:---:              |:---:                |
-| `git`     | :white_check_mark:    |                       |                   | :white_check_mark:|                     |
-| `github`  | :white_check_mark:	| :white_check_mark:    | :white_check_mark:|                   | :white_check_mark:  |
-| `gitlab`  | :white_check_mark:	| :white_check_mark:    | :white_check_mark:|                   | :white_check_mark:  |
+| Type       |    Implemendet     |      Git tag       |     Changelog      |      Release       |  Write access git  |     Api token      |
+| ---------- | :----------------: | :----------------: | :----------------: | :----------------: | :----------------: | :----------------: |
+| `github`   | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |                    | :white_check_mark: |
+| `gitlab`   | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |                    | :white_check_mark: |
+| `git`      |    Comming soon    | :white_check_mark: |                    |                    | :white_check_mark: |                    |
+| `bitbuckt` |    Comming soon    | :white_check_mark: |                    |                    | :white_check_mark: |                    |
+
+
+## Supported CI Pipelines
+
+* Github Actions
+* Gitlab CI
+* Travis CI
+* Custom CI, set enviroment `CI=true`
+
+## How to use
+
+`go-semantic-release` config file 
+Create a file with the name `.release.yml` or anything else, but you need to set to every command `-c <your config file>`
+
+### Example config
+
+```yml
+commitFormat: angular
+branch:
+  master: release
+release: 'github'
+github:
+  repo: "go-semantic-release"
+  user: "nightapes"
+assets:
+  - name: ./build/go-semantic-release
+    compress: false
+  - name: ./build/go-semantic-release.exe
+    compress: false
+```
+
+#### CommitFormat
+
+Set the commit format, at the moment we support ony [angular](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit-message-format), more coming soon.
+
+```yml
+commitFormat: angular
+```
+
+#### Branch
+
+You can define which kind of release should be created for different branches. 
+
+Supported release kinds: 
+
+* `release` -> `v1.0.0`
+* `rc` -> `v1.0.0-rc.0`
+* `beta` -> `v1.0.0-beta.0`
+* `alpha` -> `v1.0.0-alpha.0`
+
+Add a branch config to your config
+
+```yml
+branch:
+  <branch-name>: <kind>
+```
+
+#### Relase
+
+At the moment we support releases to gitlab and github.
+
+##### Github 
+
+```yml
+release: 'github'
+github:
+  user: "<user/group"
+  repo: "<repositroyname>"
+  ## Optional, if your not using github.com
+  customURL: <https://your.github>
+```
+
+##### Gitlab 
+
+```yml
+release: 'gitlab'
+gitlab:
+  repo: "<repositroyname>"  ## Example group/project
+  ## Optional, if your not using gitlab.com
+  customURL: <https://your.gitlab>
+```
+
+#### Assets
+
+You can upload assets to a release
+
+Support for gitlab and github.
+If you want, you can let the file be compressed before uploading 
+
+```yml
+assets:
+  - name: ./build/go-semantic-release
+    compress: false
+```
+
+#### Changelog
+
+```yml
+changelog:
+  printAll: false ## Print all valid commits to changelog
+```
+
+##### Docker 
+
+You can print a help text for a docker image
+
+```yml
+changelog:
+  docker: 
+    latest: false ## If you uploaded a latest image
+    repository: ## Your docker repository, which is used for docker run
+```
+
+### Version
+
+`go-semantic-release` has two modes for calcualting the version: automatic or manual.
+
+#### Automatic
+
+Version will be calculated on the `next` or `release` command
+
+#### Manual
+
+If you don't want that `go-semantic-release` is calculating the version from the commits, you can set the version by hand with
+following command:
+
+```bash
+./go-semantic-release set 1.1.1
+```
+
+### Print version
+
+Print the next version, can be used to add version to your program
+
+```bash
+./go-semantic-release next
+```
+Example with go-lang
+
+```bash
+go build -ldflags "--X main.version=`./go-semantic-release next`"
+```
+
+### Create release 
+
+```bash
+./go-semantic-release release 
+```



-## Build
+## Build from source

-`go build ./cmd/go-semantic-release/`
+```bash
+go build ./cmd/go-semantic-release/
+```

-## Run
+### Testing

-Print the next version
+```bash
+go test ./... 
+```

-`./go-semantic-release version next`
+### Linting

-Set a version
-
-`./go-semantic-release version set v1.1.1`
+```
+curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s -- -b $(go env GOPATH)/bin v1.16.0
+golangci-lint run ./...
+```