crossplane
/
docs
mirror of https://github.com/crossplane/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix Vale errors in release cycle docs and warnings in new release dates section 

Signed-off-by: Jared Watts <jbw976@gmail.com>
This commit is contained in:
Jared Watts 2023-07-05 12:20:13 +02:00
parent 30715e2518
commit 9044a051ee
No known key found for this signature in database
GPG Key ID: 0467EEAE3B6EC0D2
1 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
content/knowledge-base/guides/release-cycle.md
View File

@ -6,7 +6,7 @@ weight: 308
Starting with the v1.10.0 release, Crossplane is released on a quarterly (13 Starting with the v1.10.0 release, Crossplane is released on a quarterly (13
week) cadence. A cycle is comprised of three general stages: week) cadence. A cycle is comprised of three general stages:
- Weeks 1-11: [Active Development] - Weeks 1—11: [Active Development]
- Week 12: [Feature Freeze] - Week 12: [Feature Freeze]
- Week 13: [Code Freeze] - Week 13: [Code Freeze]
@ -15,18 +15,18 @@ being maintained at any given time. When a new release is cut, the fourth most
recent release reaches end of life (EOL). Users can expect any given release to recent release reaches end of life (EOL). Users can expect any given release to
be maintained for nine months. be maintained for nine months.
### Definition of Maintenance ### Definition of maintenance
The Crossplane community defines maintenance in that relevant bug fixes that are The Crossplane community defines maintenance in that relevant bug fixes that are
merged to the main development branch will be eligible to be back-ported to the merged to the main development branch will be eligible to be back-ported to the
release branch of any currently maintained version, and patch releases will be release branch of any currently maintained version, and patch releases will be
cut appropriately. It is also possible that a fix may be merged directly to the cut appropriately. It's also possible that a fix may be merged directly to the
release branch if no longer applicable on the main development branch. release branch if no longer applicable on the main development branch.
Maintenance does not indicate any SLA on response time for user support in the Maintenance doesn't indicate any SLA on response time for user support in the
form of Slack messages or issues, but problems will be addressed on a best form of Slack messages or issues, but problems will be addressed on a best
effort basis by maintainers and contributors for currently maintained releases. effort basis by maintainers and contributors for currently maintained releases.
### Patch Releases ### Patch releases
_This policy is subject to change in the future._ _This policy is subject to change in the future._
@ -34,26 +34,26 @@ Patch releases are cut for currently maintained minor versions on an as-needed
basis. Any critical back-ported fixes will be included in a patch release as basis. Any critical back-ported fixes will be included in a patch release as
soon as possible after merge. soon as possible after merge.
### Pre-Releases ### Pre-releases
_This policy is subject to change in the future._ _This policy is subject to change in the future._
Alpha, Beta, and RC releases are cut for an upcoming release on an as-needed Alpha, Beta, and RC releases are cut for an upcoming release on an as-needed
basis. As a policy, at least one pre-release will be cut prior to any minor basis. As a policy, at least one pre-release will be cut prior to any minor
release. Pre-releases will not be made on release branches. release. Pre-releases won't be made on release branches.
### Provider Releases ### Provider releases
The Crossplane release cycle is not required to be adhered to by any other The Crossplane release cycle isn't required to be adhered to by any other
Crossplane projects, but a similar cadence is encouraged. Maintainers listed in Crossplane projects, but a similar cadence is encouraged. Maintainers listed in
each repository's `OWNERS.md` file are responsible for determining and each repository's `OWNERS.md` file are responsible for determining and
publishing the release cycle for their project. publishing the release cycle for their project.
## Release Stages ## Release stages
The following stages are the main milestones in a Crossplane release. The following stages are the main milestones in a Crossplane release.
### Active Development ### Active development
During active development, any code that meets the requisite criteria (i.e. During active development, any code that meets the requisite criteria (i.e.
passing appropriate tests, approved by a maintainer, etc.) will be merged into passing appropriate tests, approved by a maintainer, etc.) will be merged into
@ -62,7 +62,7 @@ submit an enhancement proposal prior to the start of the release cycle, but
contributors are encouraged to open an issue and gather feedback before starting contributors are encouraged to open an issue and gather feedback before starting
work on a major implementation (see [CONTRIBUTING.md] for more information). work on a major implementation (see [CONTRIBUTING.md] for more information).
### Feature Freeze ### Feature freeze
During feature freeze, no new functionality should be merged into the main During feature freeze, no new functionality should be merged into the main
development branch. Bug fixes, documentation changes, and non-critical changes development branch. Bug fixes, documentation changes, and non-critical changes
@ -70,26 +70,26 @@ may be made. In the case that a new feature is deemed absolutely necessary for a
release, the Crossplane maintainers will weigh the impact of the change and make release, the Crossplane maintainers will weigh the impact of the change and make
a decision on whether it should be included. a decision on whether it should be included.
### Code Freeze ### Code freeze
During code freeze, there should be no changes merged to the main development During code freeze, there should be no changes merged to the main development
branch with the following exceptions: branch with the following exceptions:
- Fixes to a failing test that is deemed to be incorrectly testing - Fixes to a failing test that's deemed to be incorrectly testing
functionality. functionality.
- Documentation only changes. It is possible that a documentation freeze will be - Documentation only changes. It's possible that a documentation freeze will be
implemented in the future, but it is not currently enforced. implemented in the future, but it's not currently enforced.
- Fixes to a critical bug that was not previously identified. Merging a bug fix - Fixes to a critical bug that wasn't previously identified. Merging a bug fix
during code freeze requires application for and approval of an exception by during code freeze requires application for and approval of an exception by
Crossplane maintainers. This process is currently informal, but may be Crossplane maintainers. This process is currently informal, but may be
formalized in the future. formalized in the future.
## Release Dates ## Release dates
Crossplane is released on a quarterly (13 week) cadence. Typically, the release Crossplane releases once a quarter (every 13 weeks). Typically, the release
will happen on Tuesday of the last week of the quarter, as shown on the happens on the Tuesday of the last week of the quarter, as shown on the
[community calendar][community calendar]. Please keep in mind that the specific [community calendar][community calendar]. Keep in mind that the specific date is
date is **approximate**. A number of factors can alter the date slightly, such **approximate**. A lot of factors can alter the date slightly, such as code
as code reviews, testing, and bug fixing to ensure a quality release. reviews, testing, and bug fixing to ensure a quality release.
<!-- Named links --> <!-- Named links -->