Skip to content

Commit 2e87c5d

Browse files
christophwitzkochristophwitzko
committed
feat: initial
1 parent 7fe8033 commit 2e87c5d

13 files changed

+1016
-0
lines changed

‎.github/workflows/ci.yml

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: CI
2+
on:
3+
push:
4+
branches:
5+
- '**'
6+
pull_request:
7+
branches:
8+
- '**'
9+
jobs:
10+
lint:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
- uses: actions/setup-go@v3
15+
with:
16+
go-version: 1.19
17+
- uses: golangci/golangci-lint-action@v3
18+
test:
19+
runs-on: ubuntu-latest
20+
needs: lint
21+
steps:
22+
- uses: actions/checkout@v3
23+
- uses: actions/setup-go@v3
24+
with:
25+
go-version: 1.19
26+
- run: go build ./
27+
- run: go test ./...
28+
release:
29+
runs-on: ubuntu-latest
30+
needs: test
31+
steps:
32+
- uses: actions/checkout@v3
33+
- uses: actions/setup-go@v3
34+
with:
35+
go-version: 1.19
36+
- run: ./scripts/build-local.sh
37+
- uses: go-semantic-release/action@v1
38+
with:
39+
hooks: goreleaser,plugin-registry-update,exec
40+
env:
41+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
42+
PLUGIN_REGISTRY_ADMIN_ACCESS_TOKEN: ${{ secrets.PLUGIN_REGISTRY_ADMIN_ACCESS_TOKEN }}

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.idea/
2+
.envrc

‎.golangci.yaml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
linters:
2+
enable:
3+
- errorlint
4+
- forbidigo
5+
- gochecknoinits
6+
- gocritic
7+
- goconst
8+
- gocyclo
9+
- gofumpt
10+
- goimports
11+
- misspell
12+
- revive
13+
- unconvert
14+
- unparam
15+
- wastedassign
16+
17+
linters-settings:
18+
gocyclo:
19+
min-complexity: 12
20+
gofumpt:
21+
extra-rules: true
22+
govet:
23+
enable-all: true
24+
disable:
25+
- fieldalignment

‎.goreleaser.yaml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
builds:
2+
- env:
3+
- CGO_ENABLED=0
4+
targets:
5+
- linux_amd64
6+
- linux_arm64
7+
- darwin_amd64
8+
- darwin_arm64
9+
- linux_arm
10+
- windows_amd64
11+
main: ./
12+
flags:
13+
- -trimpath
14+
ldflags:
15+
- -extldflags '-static'
16+
- -s -w -X main.version={{.Version}}
17+
18+
archives:
19+
- format: binary
20+
name_template: '{{ .Binary }}_v{{ .Version }}_{{ .Os }}_{{ .Arch }}'
21+
22+
checksum:
23+
name_template: '{{ .ProjectName }}_v{{ .Version }}_checksums.txt'

‎.semrelrc

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"plugins": {
3+
"hooks": {
4+
"names": [
5+
"exec"
6+
],
7+
"options": {
8+
"exec_on_success": "echo 'v{{.PrevRelease.Version}} -> v{{.NewRelease.Version}} ({{len .Commits}} commits)'",
9+
"exec_on_no_release": "echo {{.Reason}}: {{.Message}}"
10+
}
11+
}
12+
}
13+
}

‎CODE_OF_CONDUCT.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

‎LICENSE

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Copyright (c) 2023 Christoph Witzko
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is
8+
furnished to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19+
SOFTWARE.

‎README.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# :mechanical_arm: hooks-exec
2+
[![CI](https://github.com/go-semantic-release/hooks-exec/workflows/CI/badge.svg?branch=main)](https://github.com/go-semantic-release/hooks-exec/actions?query=workflow%3ACI+branch%3Amain)
3+
[![Go Report Card](https://goreportcard.com/badge/github.com/go-semantic-release/hooks-exec)](https://goreportcard.com/report/github.com/go-semantic-release/hooks-exec)
4+
[![PkgGoDev](https://pkg.go.dev/badge/github.com/go-semantic-release/hooks-exec)](https://pkg.go.dev/github.com/go-semantic-release/hooks-exec)
5+
6+
This plugin allows to execute custom scripts during the semantic-release process.
7+
8+
## Usage
9+
Use this plugin by enabling it via `--hooks exec`.
10+
11+
## Configuration
12+
There are two possible scripts that can be executed during the release process: (i) the success script, if the release was successful, and (ii) the no release script, if the was not created for a specific reason.
13+
14+
The scripts are configured via the `--hooks-opts exec_on_success="echo v{{.NewRelease.Version}} "` and `--hooks-opts exec_no_release= echo {{.Reason}}` flags. Additionally, they `.semrelrc` file can be used to configure the scripts:
15+
```json
16+
{
17+
"plugins": {
18+
"hooks": {
19+
"names": [
20+
"exec"
21+
],
22+
"options": {
23+
"exec_on_success": "echo v{{.PrevRelease.Version}} '->' v{{.NewRelease.Version}}",
24+
"exec_on_no_release": "echo {{.Reason}}: {{.Message}}"
25+
}
26+
}
27+
}
28+
}
29+
30+
```
31+
32+
### Success script configuration
33+
The success script configuration accepts Go templates with the following variables:
34+
- `{{.PrevRelease.Version}}`: The previous release version.
35+
- `{{.NewRelease.Version}}`: The new release version.
36+
- `{{.Changelog}}`: The release changelog.
37+
- `{{.Commits}}`: The commits between the previous and the new release.
38+
- `{{.RepoInfo}}`: The repository information.
39+
40+
A more detailed documentation about the available variables can be found [here](https://pkg.go.dev/github.com/go-semantic-release/semantic-release/v2/pkg/hooks#SuccessHookConfig).
41+
42+
### No release script configuration
43+
The no release script configuration also accepts Go templates with the following variables:
44+
- `{{.Reason}}`: The reason why no release was created. One of
45+
- `{{.Message}}`: The message why no release was created
46+
47+
A more detailed documentation about the available variables can be found [here](https://pkg.go.dev/github.com/go-semantic-release/semantic-release/v2/pkg/hooks#NoReleaseConfig).
48+
49+
## Licence
50+
51+
The [MIT License (MIT)](http://opensource.org/licenses/MIT)
52+
53+
Copyright © 2023 [Christoph Witzko](https://twitter.com/christophwitzko)

‎go.mod

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
module github.com/go-semantic-release/hooks-exec
2+
3+
go 1.19
4+
5+
require (
6+
github.com/go-semantic-release/semantic-release/v2 v2.26.1
7+
github.com/mattn/go-shellwords v1.0.12
8+
github.com/stretchr/testify v1.8.1
9+
)
10+
11+
require (
12+
github.com/Masterminds/semver/v3 v3.2.0 // indirect
13+
github.com/davecgh/go-spew v1.1.1 // indirect
14+
github.com/fatih/color v1.14.1 // indirect
15+
github.com/fsnotify/fsnotify v1.6.0 // indirect
16+
github.com/golang/protobuf v1.5.2 // indirect
17+
github.com/hashicorp/go-hclog v1.4.0 // indirect
18+
github.com/hashicorp/go-plugin v1.4.8 // indirect
19+
github.com/hashicorp/hcl v1.0.0 // indirect
20+
github.com/hashicorp/yamux v0.1.1 // indirect
21+
github.com/inconshreveable/mousetrap v1.1.0 // indirect
22+
github.com/magiconair/properties v1.8.7 // indirect
23+
github.com/mattn/go-colorable v0.1.13 // indirect
24+
github.com/mattn/go-isatty v0.0.17 // indirect
25+
github.com/mitchellh/go-testing-interface v1.14.1 // indirect
26+
github.com/mitchellh/mapstructure v1.5.0 // indirect
27+
github.com/oklog/run v1.1.0 // indirect
28+
github.com/pelletier/go-toml/v2 v2.0.6 // indirect
29+
github.com/pmezard/go-difflib v1.0.0 // indirect
30+
github.com/spf13/afero v1.9.3 // indirect
31+
github.com/spf13/cast v1.5.0 // indirect
32+
github.com/spf13/cobra v1.6.1 // indirect
33+
github.com/spf13/jwalterweatherman v1.1.0 // indirect
34+
github.com/spf13/pflag v1.0.5 // indirect
35+
github.com/spf13/viper v1.15.0 // indirect
36+
github.com/subosito/gotenv v1.4.2 // indirect
37+
golang.org/x/net v0.6.0 // indirect
38+
golang.org/x/sys v0.5.0 // indirect
39+
golang.org/x/text v0.7.0 // indirect
40+
google.golang.org/genproto v0.0.0-20230202175211-008b39050e57 // indirect
41+
google.golang.org/grpc v1.53.0 // indirect
42+
google.golang.org/protobuf v1.28.1 // indirect
43+
gopkg.in/ini.v1 v1.67.0 // indirect
44+
gopkg.in/yaml.v3 v3.0.1 // indirect
45+
)

0 commit comments

Comments
 (0)