DOCS: update release policy to match reality

This commit is contained in:
sfan5 2022-11-13 15:01:34 +01:00
parent 2f747341f9
commit 1e9a2cbebf
1 changed files with 23 additions and 18 deletions

View File

@ -1,13 +1,15 @@
Release Policy Release Policy
============== ==============
Once or twice a month, a new release is cut off of the master branch and is Once or twice a year, a new release is cut off of the master branch and is
assigned a 0.X.Y version number, where X is incremented each time a release assigned a 0.X.Y version number, where X is incremented each time a release
contains breaking changes, such as changed options or added/removed features, contains breaking changes, such as changed options or added/removed features,
and Y is incremented if a release contains only bugfixes and other minor and Y is incremented if a release contains only bugfixes and other minor
changes. changes.
Releases are tagged on the master branch and will not be maintained separately. Releases are tagged on the master branch and will not be maintained separately.
Patch releases may be made if the amount or severity of bugs justify it, or in
the event of security issues.
The goal of releases is to provide Linux distributions with something to The goal of releases is to provide Linux distributions with something to
package. If you want the newest features, just use the master branch. package. If you want the newest features, just use the master branch.
@ -31,13 +33,13 @@ While on master:
- Create signed tag v0.X.Y. - Create signed tag v0.X.Y.
- Add -UNKNOWN suffix to version in `VERSION` file. - Push release branch (`release/0.X`) and tag to GitHub.
- Commit changes, push release branch (`release/0.X`) and tag to GitHub.
- Create a new GitHub release using the content of `RELEASE_NOTES` related to - Create a new GitHub release using the content of `RELEASE_NOTES` related to
the new version. the new version.
- Readd -UNKNOWN suffix to version in `VERSION` file.
If necessary (to e.g. exclude commits already on master), the release can If necessary (to e.g. exclude commits already on master), the release can
be done on a branch with different commit history. The release branch **must** be done on a branch with different commit history. The release branch **must**
then be merged to master so `git describe` will pick up the tag. then be merged to master so `git describe` will pick up the tag.
@ -45,12 +47,14 @@ then be merged to master so `git describe` will pick up the tag.
Release notes template Release notes template
---------------------- ----------------------
Here is a template that can be used for writing the `RELEASE_NOTES` file. Here is a template that can be used for writing the `RELEASE_NOTES` file:
```markdown ```markdown
Release 0.X.Y Release 0.X.Y
============= =============
This release requires FFmpeg <ver> or newer.
Features Features
-------- --------
@ -59,20 +63,18 @@ New
- List of new features - List of new features
Removed
Changed
~~~~~~~ ~~~~~~~
- List of removed features - List of removed features
Deprecated
Removed
~~~~~~~~~~ ~~~~~~~~~~
- List of deprecated features - List of deprecated features
Behavior
--------
- List of user-visible changes in behavior
Options and Commands Options and Commands
-------------------- --------------------
@ -82,34 +84,37 @@ Added
- List of added options and commands - List of added options and commands
Changed Changed
~~~~~~~ ~~~~~~~
- List of changed options and commands - List of changed options and commands
Renamed
~~~~~~~
- List of renamed options and commands
Deprecated Deprecated
~~~~~~~~~~ ~~~~~~~~~~
- List of deprecated options and commands - List of deprecated options and commands
Removed Removed
~~~~~~~ ~~~~~~~
- List of removed options and commands - List of removed options and commands
Fixes and Minor Enhancements Fixes and Minor Enhancements
---------------------------- ----------------------------
- List of fixes and minor enhancements - List of fixes and minor enhancements
This listing is not complete. There are many more bug fixes and changes. The
complete change log can be viewed by running `git log <start>..<end>` in This listing is not complete. Check DOCS/client-api-changes.rst for a history
the git repository. of changes to the client API, and DOCS/interface-changes.rst for a history
of changes to other user-visible interfaces.
A complete changelog can be seen by running `git log <start>..<end>`
in the git repository.
``` ```
Note that the "Release 0.X.Y" title should be removed when creating a new GitHub Note that the "Release 0.X.Y" title should be removed when creating a new GitHub