Skip to content

Commit fa91354

Browse files
mavogelmavogel
authored
feat: add semantic release (#12)
* fix: build and linting Signed-off-by: Manuel Vogel <[email protected]> * feat: add semantic release Signed-off-by: Manuel Vogel <[email protected]> * chore: remove deprecated tools Signed-off-by: Manuel Vogel <[email protected]> * feat: add renovate Signed-off-by: Manuel Vogel <[email protected]> * fix: back from main to tmp master Signed-off-by: Manuel Vogel <[email protected]> * fix: run test and lint on PR Signed-off-by: Manuel Vogel <[email protected]> * fix(ci): use also GH token for semantic release Signed-off-by: Manuel Vogel <[email protected]> --------- Signed-off-by: Manuel Vogel <[email protected]>
1 parent 8b09f88 commit fa91354

14 files changed

+194
-182
lines changed

‎.chglog/CHANGELOG.tpl.md

-40
This file was deleted.

‎.chglog/config.yml

-33
This file was deleted.

‎.github/renovate.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
3+
"extends": [
4+
"config:recommended"
5+
]
6+
}

‎.github/workflows/lint.yml

+10-10
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ on:
88
push:
99
branches:
1010
- master
11-
paths-ignore:
12-
- 'README.md'
11+
12+
permissions:
13+
contents: read
1314

1415
jobs:
15-
golangci:
16+
lint:
1617
name: lint
17-
runs-on: ubuntu-20.04
18+
runs-on: ubuntu-latest
1819
steps:
19-
- name: Checkout
20-
uses: actions/checkout@v2
20+
- uses: actions/checkout@v4
21+
- uses: actions/setup-go@v5
2122
with:
22-
fetch-depth: 0
23+
go-version: '1.21.x'
24+
cache: false
2325
- name: golangci-lint
24-
uses: golangci/golangci-lint-action@v2
25-
with:
26-
version: v1.40.0
26+
uses: golangci/golangci-lint-action@v6

‎.github/workflows/release.yml

-26
This file was deleted.

‎.github/workflows/semantic-lint.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: semantic-lint
2+
3+
on:
4+
pull_request_target:
5+
types:
6+
- opened
7+
- edited
8+
- synchronize
9+
10+
permissions:
11+
contents: read
12+
pull-requests: read
13+
14+
jobs:
15+
lint:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: amannn/action-semantic-pull-request@v5
19+
env:
20+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/semantic.yml

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: semantic
2+
on:
3+
push:
4+
branches:
5+
- master
6+
- next
7+
8+
permissions:
9+
contents: read # for checkout
10+
11+
jobs:
12+
release:
13+
name: release
14+
runs-on: ubuntu-latest
15+
permissions:
16+
contents: write # to be able to publish a GitHub release
17+
issues: write # to be able to comment on released issues
18+
pull-requests: write # to be able to comment on released pull requests
19+
id-token: write # to enable use of OIDC for npm provenance
20+
steps:
21+
- name: checkout
22+
uses: actions/checkout@v4
23+
with:
24+
fetch-depth: 0
25+
- name: setup node.js
26+
uses: actions/setup-node@v4
27+
with:
28+
node-version: "lts/*"
29+
- name: release
30+
env:
31+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
32+
run: |
33+
npx \
34+
-p @semantic-release/commit-analyzer \
35+
-p @semantic-release/release-notes-generator \
36+
-p @semantic-release/github \
37+
semantic-release --debug

‎.github/workflows/test.yml

+16-11
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,27 @@ on:
1212
- 'README.md'
1313
jobs:
1414
unit:
15-
runs-on: ubuntu-20.04
15+
runs-on: ubuntu-latest
1616
steps:
1717
- name: Checkout
18-
uses: actions/checkout@v2
18+
uses: actions/checkout@v4
1919
with:
2020
fetch-depth: 0
2121
- name: Set up Go
22-
uses: actions/setup-go@v2
22+
uses: actions/setup-go@v5
2323
with:
24-
go-version: 1.16
24+
go-version: 1.21.x
2525
- name: Run tests
2626
run: make test
27-
- name: Convert coverage
28-
uses: jandelgado/[email protected]
29-
- name: Upload coverage
30-
uses: coverallsapp/github-action@master
31-
with:
32-
github-token: ${{ secrets.github_token }}
33-
path-to-lcov: coverage.lcov
27+
#- name: Upload coverage reports to Codecov
28+
# uses: codecov/codecov-action@v4
29+
# env:
30+
# CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
31+
#- name: Upload coverage reports to Codeclimate
32+
# if: github.event_name != 'pull_request'
33+
# uses: paambaati/[email protected]
34+
# env:
35+
# CC_TEST_REPORTER_ID: ${{ secrets.CODECLIMATE_TEST_REPORTER_ID }}
36+
# with:
37+
# prefix: "github.com/mavogel/go-ssh-forward"
38+
# coverageLocations: coverage.txt:gocov

‎.golangci.yml

+70-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,73 @@
1-
run:
2-
tests: false
1+
linters-settings:
2+
dupl:
3+
threshold: 100
4+
funlen:
5+
lines: 100
6+
statements: 50
7+
goconst:
8+
min-len: 2
9+
min-occurrences: 3
10+
gocritic:
11+
enabled-tags:
12+
- diagnostic
13+
- experimental
14+
- opinionated
15+
- performance
16+
- style
17+
disabled-checks:
18+
- dupImport # https://github.com/go-critic/go-critic/issues/845
19+
- ifElseChain
20+
- octalLiteral
21+
- whyNoLint
22+
gocyclo:
23+
min-complexity: 15
24+
golint:
25+
min-confidence: 0
26+
lll:
27+
line-length: 140
28+
maligned:
29+
suggest-new: true
30+
misspell:
31+
locale: US
332

433
linters:
5-
enable-all: true
6-
disable:
34+
# please, do not use `enable-all`: it's deprecated and will be removed soon.
35+
# inverted configuration with `enable-all` and `disable` is not scalable during updates of golangci-lint
36+
disable-all: true
37+
enable:
38+
- bodyclose
39+
- dogsled
40+
- errcheck
41+
- funlen
42+
- goconst
43+
- gocritic
44+
- gocyclo
45+
- gofmt
46+
- goimports
47+
- goprintffuncname
48+
- gosec
49+
- gosimple
50+
- govet
51+
- ineffassign
752
- lll
8-
- exhaustivestruct
9-
- interfacer
10-
- maligned
11-
- scopelint
53+
- misspell
54+
- nakedret
55+
- nilnil
56+
- noctx
57+
- nolintlint
58+
- staticcheck
59+
- stylecheck
60+
- typecheck
61+
- unconvert
62+
- unparam
63+
- unused
64+
- whitespace
65+
66+
issues:
67+
exclude-rules:
68+
- path: _test\.go
69+
linters:
70+
- funlen
71+
72+
run:
73+
timeout: 2m

‎.releaserc.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
plugins:
2+
- "@semantic-release/commit-analyzer"
3+
- "@semantic-release/release-notes-generator"
4+
- - "@semantic-release/github"
5+
- successComment: |
6+
:tada: This ${issue.pull_request ? 'pull request is included' : 'issue has been resolved'} in version ${nextRelease.version} :tada:
7+
8+
The release is available on [GitHub release](https://github.com/mavogel/go-ssh-forward/releases/tag/${nextRelease.gitTag}) :rocket:
9+
10+
branches:
11+
- name: +([0-9])?(.{+([0-9]),x}).x
12+
- name: master
13+
- name: next
14+
prerelease: true
15+
- name: pre/rc
16+
prerelease: '${name.replace(/^pre\\//g, "")}'

‎Makefile

+3-36
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ GOOS ?= $(shell $(GO) env GOOS)
77
GOARCH ?= $(shell $(GO) env GOARCH)
88
GOHOST ?= GOOS=$(GOOS) GOARCH=$(GOARCH) $(GO)
99

10-
# Tool versions
11-
GOLANGCI_VERSION = 1.39.0
12-
GITCHGLOG_VERSION = 0.14.2
13-
1410
.PHONY: all
1511
all: help
1612

@@ -20,41 +16,12 @@ all: help
2016
.PHONY: test
2117
test: ## Run tests
2218
@ $(MAKE) --no-print-directory log-$@
23-
$(GOHOST) test -race -covermode atomic -coverprofile coverage.out -v ./...
24-
25-
bin/golangci-lint: bin/golangci-lint-${GOLANGCI_VERSION}
26-
@ln -sf golangci-lint-${GOLANGCI_VERSION} bin/golangci-lint
27-
bin/golangci-lint-${GOLANGCI_VERSION}:
28-
@mkdir -p bin
29-
curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | BINARY=golangci-lint bash -s -- v${GOLANGCI_VERSION}
30-
@mv bin/golangci-lint $@
19+
$(GOHOST) test -timeout 60s -race -covermode atomic -coverprofile coverage.txt -v ./...
3120

3221
.PHONY: lint
33-
lint: bin/golangci-lint ## Run linters
34-
@ $(MAKE) --no-print-directory log-$@
35-
bin/golangci-lint run
36-
37-
###########
38-
##@ Release
39-
40-
bin/git-chglog: bin/git-chglog-${GITCHGLOG_VERSION}
41-
@ln -sf git-chglog-${GITCHGLOG_VERSION} bin/git-chglog
42-
bin/git-chglog-${GITCHGLOG_VERSION}:
43-
@mkdir -p bin
44-
curl -L https://github.com/git-chglog/git-chglog/releases/download/v${GITCHGLOG_VERSION}/git-chglog_${GITCHGLOG_VERSION}_${OS}_amd64.tar.gz | tar -zOxf - git-chglog > ./bin/git-chglog-${GITCHGLOG_VERSION} && chmod +x ./bin/git-chglog-${GITCHGLOG_VERSION}
45-
46-
.PHONY: changelog
47-
changelog: bin/git-chglog ## Generate changelog
48-
@ $(MAKE) --no-print-directory log-$@
49-
bin/git-chglog --next-tag $(VERSION) -o CHANGELOG.md
50-
51-
.PHONY: release
52-
release: changelog ## Release a new tag
22+
lint: ## Run linters
5323
@ $(MAKE) --no-print-directory log-$@
54-
git add CHANGELOG.md
55-
git commit -m "chore: update changelog for $(VERSION)"
56-
git tag $(VERSION)
57-
git push origin master $(VERSION)
24+
golangci-lint run
5825

5926
########
6027
##@ Help

0 commit comments

Comments
 (0)