Skip to content

Commit

Permalink
docs: basic description of our release process
Browse files Browse the repository at this point in the history
We have maintainer docs regarding our release process, but nothing for
normal users.  Let's fix that with a small section in our README.md.

Signed-off-by: Paul Moore <paul@paul-moore.com>
Signed-off-by: Tom Hromatka <tom.hromatka@oracle.com>
  • Loading branch information
pcmoore authored and drakenclimber committed Sep 20, 2024
1 parent 87876aa commit 9c4eb5e
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,20 @@ The generated seccomp-bpf filters can be tested on a live system using the
These tests will fail if the running Linux Kernel does not provide the
necessary support.

## Release Process

GitHub milestones are used to track development and manage new releases. We do
not currently follow a regular, calendar based release schedule; the libseccomp
releases are determined by the number of outstanding issues and pull-requests
assigned to the related GitHub milestone, when all of the outstanding items in
the milestone have been closed, we create a new release.

If you believe a particular issue or pull-request should be part of a release
milestone, or excluded from one, please leave a comment in the issue or
pull-request. Creating new issues solely for the purpose of asking about the
next release is strongly discouraged, and will likely be closed with a
reference to this section in the project's README.

## Developer Tools

The "tools/" directory includes a number of tools which may be helpful in the
Expand Down

0 comments on commit 9c4eb5e

Please sign in to comment.