Skip to content

Commit 28514d8

Browse files
committed
docs: update RELEASE_PROCESS.md and README.md
Update our release process and README documentation based on our current plans. These docs can (and should!) be updated as needed to reflect changes in our processes. Acked-by: Tom Hromatka <[email protected]> Signed-off-by: Paul Moore <[email protected]>
1 parent c767664 commit 28514d8

File tree

2 files changed

+66
-3
lines changed

2 files changed

+66
-3
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,33 @@ Documentation for this package is also available at:
2626

2727
* https://pkg.go.dev/github.com/seccomp/libseccomp-golang
2828

29+
## Verifying Releases
30+
31+
Starting with libseccomp-golang v0.9.2, the git tag corresponding to each
32+
release should be signed by one of the libseccomp-golang maintainers. It is
33+
recommended that before use you verify the release tags using the following
34+
command:
35+
36+
% git tag -v <tag>
37+
38+
At present, only the following keys, specified via the fingerprints below, are
39+
authorized to sign official libseccomp-golang release tags:
40+
41+
Paul Moore <[email protected]>
42+
7100 AADF AE6E 6E94 0D2E 0AD6 55E4 5A5A E8CA 7C8A
43+
44+
Tom Hromatka <[email protected]>
45+
47A6 8FCE 37C7 D702 4FD6 5E11 356C E62C 2B52 4099
46+
47+
Kir Kolyshkin <[email protected]>
48+
C242 8CD7 5720 FACD CF76 B6EA 17DE 5ECB 75A1 100E
49+
50+
More information on GnuPG and git tag verification can be found at their
51+
respective websites: https://git-scm.com/docs/git and https://gnupg.org.
52+
2953
## Installing the package
3054

31-
# go get github.com/seccomp/libseccomp-golang
55+
% go get github.com/seccomp/libseccomp-golang
3256

3357
## Contributing
3458

doc/admin/RELEASE_PROCESS.md

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,45 @@ https://github.com/seccomp/libseccomp-golang
55
This is the process that should be followed when creating a new
66
libseccomp-golang release.
77

8-
#### TODO: create a release process using libseccomp as a reference
8+
#### 1. Verify that all issues assigned to the release milestone have been resolved
99

10-
* https://github.com/seccomp/libseccomp/blob/main/doc/admin/RELEASE_PROCESS.md
10+
* https://github.com/seccomp/libseccomp-golang/milestones
11+
12+
#### 2. Verify that the syntax/style meets the guidelines
13+
14+
% make check-syntax
15+
16+
#### 3. Verify that the bundled tests run without error
17+
18+
% make vet
19+
% make check
20+
21+
#### 4. If any problems were found up to this point that resulted in code changes, restart the process
22+
23+
#### 5. Update the CHANGELOG file with significant changes since the last release
24+
25+
#### 6. If this is a new major/minor release, create new 'release-X.Y' branch
26+
27+
% stg branch -c "release-X.Y"
28+
29+
... or ...
30+
31+
% git branch "release-X.Y"
32+
33+
#### 7. Tag the release in the local repository with a signed tag
34+
35+
% git tag -s -m "version X.Y.Z" vX.Y.Z
36+
37+
#### 8. Push the release tag to the main GitHub repository
38+
39+
% git push <repo> vX.Y.Z
40+
41+
#### 9. Create a new GitHub release using the associated tag, add the relevant section from the CHANGELOG file
42+
43+
#### 19. Update the GitHub release notes for older releases which are now unsupported
44+
45+
The following Markdown text is suggested at the top of the release note, see old GitHub releases for examples.
46+
47+
```
48+
***This release is no longer supported upstream, please use a more recent release***
49+
```

0 commit comments

Comments
 (0)