Skip to content

Commit 126dbdd

Browse files
committed
docs: Add release checklist
1 parent bd9122d commit 126dbdd

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

.github/releases.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Release preparation
2+
3+
1. Run linters, fix all simple warnings. If the behavior is intentional - add
4+
`nolint` comment and explanation. If the warning is non-trviail to fix - open
5+
an issue.
6+
```
7+
golangci-lint run
8+
```
9+
10+
2. Run unit tests suite. Verify that all disabled tests are not related to
11+
serious problems and have corresponding issue open.
12+
```
13+
go test ./...
14+
```
15+
16+
3. Run integration tests suite. Verify that all disabled tests are not related
17+
to serious problems and have corresponding issue open.
18+
```
19+
cd tests/
20+
./run.sh
21+
```
22+
23+
4. Use environment configuration from maddy-repro bundle
24+
(https://foxcpp.dev/maddy-repro) to build release artifacts.
25+
26+
5. Create detached PGP signatures for artifacts using key
27+
3197BBD95137E682A59717B434BB2007081396F4.
28+
29+
6. Create sha256sums file for artifacts.
30+
31+
7. Create PGP-signed Git tag and write release notes into its description.
32+
33+
8. Push Git tag to GitHub. Create release on GitHub using the same text for
34+
release notes. Attach signed artifacts and sha256sums file.

0 commit comments

Comments
 (0)