Update README to include release process comment (#6877)

This commit is contained in:
Teddy Reed 2021-01-02 11:06:48 -05:00 committed by GitHub
parent 7cbc19038e
commit b56ce6a03b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 14 deletions

View File

@ -120,9 +120,8 @@ the core team can merge pull requests and therefore at least one core
team member will always review your PR, however reviews from the
community are highly encouraged and desirable.
Finally we try to keep only active PRs open. If your PR is stale we
will close it, however if you want to get back to it at a certain
point feel free to re-open, or comment on it.
Finally, we try to keep only active PRs open, and we like to merge PRs as quickly as possible.
If your PR is stale we will close it, however if you want to get back to it at a certain point feel free to re-open, or comment on it.
### A note about labels
@ -134,18 +133,13 @@ don't need to care too much about this.
### Milestones and release versions
We currently do not use any strict versioning scheme and we cut new
versions as we feel it makes sense according to the new features
implemented, whether critical bug-fixes where merged, the size of the
release (i.e. how many commits since last version), etc. We will
however keep some near future milestones open and tag each PR with the
milestone we think it is going to be merged for.
We currently do not use a strict release schedule and we tag new minor versions ideally every two months.
Otherwise, we may tag a release if it makes sense according to the new features implemented or if critical bug-fixes where merged.
We keep several near-future milestones open and try to tag PRs with the milestone when appropriate.
Milestones are used for larger releases and we might cut patch
releases as we go. If your PR is tagged with the next milestone you
can expect it to be merged as soon as it is ready. If your PR is
tagged with a later milestone we'll only merge it after the previous
milestones are closed.
[Milestones](https://github.com/osquery/osquery/milestones) are used for the planned minor releases.
If your PR is tagged with the next milestone you can expect it to be merged as soon as it is ready.
We may keep PRs open and wait for a major release milestone if the code changes features that are not backwards-compatible.
### Branches and tags

View File

@ -90,6 +90,15 @@ To download the latest stable builds and for repository information
and installation instructions visit
[https://osquery.io/downloads](https://osquery.io/downloads/).
We use a simple numbered versioning scheme `X.Y.Z`, where X is a major version, Y is a minor, and Z is a patch.
We plan minor releases roughly every two months. These releases are tracked on our [Milestones](https://github.com/osquery/osquery/milestones) page. A patch release is used when there are unforeseen bugs with our minor release and we need to quickly patch.
A rare 'revision' release might be used if we need to change build configurations.
Major, minor, and patch releases are tagged on GitHub and can be viewed on the [Releases](https://github.com/osquery/osquery/releases) page.
We open a new [Release Checklist](https://github.com/osquery/osquery/blob/master/.github/ISSUE_TEMPLATE/New_Release.md) issue when we prepare a minor release. If you are interested in the status of a release, please find the corresponding checklist issue, and note that the issue will be marked closed when we are finished the checklist.
We consider a release 'in testing' during the period of hosting new downloads on our website and adding them to our hosted repositories.
We will mark the release as 'stable' on GitHub when enough testing has occurred, this usually takes two weeks.
## Build from source
Building osquery from source is encouraged! Check out our [build