You've already forked go-semantic-release
docs(README): add hooks
This commit is contained in:
27
README.md
27
README.md
@@ -6,7 +6,7 @@
|
|||||||
| ---------- | :----------------: | :----------------: | :----------------: | :----------------: | :----------------: | :----------------: |
|
| ---------- | :----------------: | :----------------: | :----------------: | :----------------: | :----------------: | :----------------: |
|
||||||
| `github` | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | | :white_check_mark: |
|
| `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: |
|
| `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: | |
|
| `git` | :white_check_mark: | :white_check_mark: | | | :white_check_mark: | |
|
||||||
| `bitbuckt` | Comming soon | :white_check_mark: | | | :white_check_mark: | |
|
| `bitbuckt` | Comming soon | :white_check_mark: | | | :white_check_mark: | |
|
||||||
|
|
||||||
|
|
||||||
@@ -37,6 +37,11 @@ assets:
|
|||||||
compress: false
|
compress: false
|
||||||
- name: ./build/go-semantic-release.exe
|
- name: ./build/go-semantic-release.exe
|
||||||
compress: false
|
compress: false
|
||||||
|
hooks:
|
||||||
|
preRelease:
|
||||||
|
- name: echo $RELEASE_VERSION
|
||||||
|
postRelease:
|
||||||
|
- name: echo $RELEASE_VERSION
|
||||||
```
|
```
|
||||||
|
|
||||||
#### CommitFormat
|
#### CommitFormat
|
||||||
@@ -65,7 +70,7 @@ branch:
|
|||||||
<branch-name>: <kind>
|
<branch-name>: <kind>
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Relase
|
#### Release
|
||||||
|
|
||||||
At the moment we support releases to gitlab and github.
|
At the moment we support releases to gitlab and github.
|
||||||
|
|
||||||
@@ -95,6 +100,20 @@ gitlab:
|
|||||||
customUrl: <https://your.gitlab>
|
customUrl: <https://your.gitlab>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
##### Git only
|
||||||
|
|
||||||
|
Only via https at the moment. You need write access to your git repository
|
||||||
|
|
||||||
|
|
||||||
|
```yml
|
||||||
|
release: 'git'
|
||||||
|
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
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
#### Assets
|
#### Assets
|
||||||
|
|
||||||
You can upload assets to a release
|
You can upload assets to a release
|
||||||
@@ -108,6 +127,10 @@ assets:
|
|||||||
compress: false
|
compress: false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Hooks
|
||||||
|
|
||||||
|
Hooks will run when calling `release`. Hooks run only if a release will be triggered.
|
||||||
|
|
||||||
#### Changelog
|
#### Changelog
|
||||||
|
|
||||||
Following variables can be used for templates:
|
Following variables can be used for templates:
|
||||||
|
|||||||
2
internal/cache/cache_test.go
vendored
2
internal/cache/cache_test.go
vendored
@@ -63,7 +63,7 @@ func TestWriteAndReadCache(t *testing.T) {
|
|||||||
Author: "Author",
|
Author: "Author",
|
||||||
Hash: "Hash",
|
Hash: "Hash",
|
||||||
},
|
},
|
||||||
ParsedMessage: "add gitlab as relase option",
|
ParsedMessage: "add gitlab as release option",
|
||||||
Scope: "releaser",
|
Scope: "releaser",
|
||||||
ParsedBreakingChangeMessage: "",
|
ParsedBreakingChangeMessage: "",
|
||||||
Tag: "feat",
|
Tag: "feat",
|
||||||
|
|||||||
Reference in New Issue
Block a user