Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RFE: add proper release process docs #94

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 25 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,37 @@ The library source repository currently lives on GitHub at the following URLs:
* https://github.com/seccomp/libseccomp-golang
* https://github.com/seccomp/libseccomp

The project mailing list is currently hosted on Google Groups at the URL below,
please note that a Google account is not required to subscribe to the mailing
list.

* https://groups.google.com/d/forum/libseccomp

Documentation for this package is also available at:

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

## Verifying Releases

Starting with libseccomp-golang v0.9.2, the git tag corresponding to each
pcmoore marked this conversation as resolved.
Show resolved Hide resolved
release should be signed by one of the libseccomp-golang maintainers. It is
recommended that before use you verify the release tags using the following
command:

% git tag -v <tag>

At present, only the following keys, specified via the fingerprints below, are
authorized to sign official libseccomp-golang release tags:

Paul Moore <paul@paul-moore.com>
7100 AADF AE6E 6E94 0D2E 0AD6 55E4 5A5A E8CA 7C8A

Tom Hromatka <tom.hromatka@oracle.com>
47A6 8FCE 37C7 D702 4FD6 5E11 356C E62C 2B52 4099

Kir Kolyshkin <kolyshkin@gmail.com>
C242 8CD7 5720 FACD CF76 B6EA 17DE 5ECB 75A1 100E

More information on GnuPG and git tag verification can be found at their
respective websites: https://git-scm.com/docs/git and https://gnupg.org.

## Installing the package

# go get github.com/seccomp/libseccomp-golang
% go get github.com/seccomp/libseccomp-golang

## Contributing

Expand Down
43 changes: 41 additions & 2 deletions doc/admin/RELEASE_PROCESS.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,45 @@ https://github.com/seccomp/libseccomp-golang
This is the process that should be followed when creating a new
libseccomp-golang release.

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

* https://github.com/seccomp/libseccomp/blob/main/doc/admin/RELEASE_PROCESS.md
* https://github.com/seccomp/libseccomp-golang/milestones

#### 2. Verify that the syntax/style meets the guidelines

% make check-syntax

#### 3. Verify that the bundled tests run without error

% make vet
% make check

#### 4. If any problems were found up to this point that resulted in code changes, restart the process

#### 5. Update the CHANGELOG file with significant changes since the last release

#### 6. If this is a new major/minor release, create new 'release-X.Y' branch

% stg branch -c "release-X.Y"

... or ...

% git branch "release-X.Y"

#### 7. Tag the release in the local repository with a signed tag

% git tag -s -m "version X.Y.Z" vX.Y.Z

#### 8. Push the release tag to the main GitHub repository

% git push <repo> vX.Y.Z

#### 9. Create a new GitHub release using the associated tag, add the relevant section from the CHANGELOG file

#### 19. Update the GitHub release notes for older releases which are now unsupported

The following Markdown text is suggested at the top of the release note, see old GitHub releases for examples.

```
***This release is no longer supported upstream, please use a more recent release***
```