cybercinch/go-semantic-release
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 14 Wiki Activity

Merge branch 'master' into feat/conventional-commits

Browse Source
This commit is contained in:
Sebastian
2021-01-21 22:43:53 +01:00
committed by GitHub
parent d6c5e395a8 3731fa6e55
commit 450383bdbf
5 changed files with 32 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -4,7 +4,7 @@
## Release Types
| Type | Implemendet | Git tag | Changelog | Release | Write access git | Api token |
| Type | Implemented | 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: |
@@ -74,7 +74,6 @@ Supported formats:
commitFormat: conventional
```
#### Branch
You can define which kind of release should be created for different branches.
@@ -106,8 +105,10 @@ release: 'github'
github:
user: "<user/group"
repo: "<repositroyname>"
## Optional, if your not using github.com
## Optional, if you are not using github.com
customUrl: <https://your.github>
## Optional, if you want to change the default tag prefix ("v")
tagPrefix: ""
```
##### Gitlab
@@ -121,6 +122,8 @@ gitlab:
repo: "<repositroyname>" ## Example group/project
## Optional, if your not using gitlab.com
customUrl: <https://your.gitlab>
## Optional, if you want to change the default tag prefix ("v")
tagPrefix: ""
```
##### Git only
@@ -134,6 +137,8 @@ git:
email: "<email>" # Used for creating tag
user: "<user>" : # Used for creating tag and pushing
auth: "<token>" # Used for pushing, can be env "$GIT_TOKEN", will be replaced with env
## Optional, if you want to change the default tag prefix ("v")
tagPrefix: ""
```
@@ -185,7 +190,7 @@ changelog:
### Version
`go-semantic-release` has two modes for calcualting the version: automatic or manual.
`go-semantic-release` has two modes for calculating the version: automatic or manual.
#### Automatic