|
1 | 1 | Changelog |
2 | 2 | ========= |
3 | 3 |
|
4 | | -Release Cycle |
5 | | -------------- |
6 | | - |
7 | | -Prior to v1, the version numbers loosely followed the rule that new features |
8 | | -would bump the minor version level, and bug fix releases would bump the patch |
9 | | -version level. |
10 | | - |
11 | | -Beginning with v1, a new scheme is adopted which allows for a "development" |
12 | | -version, and a stable version. Using the version numbers `x.y.z`, we have: |
13 | | - |
14 | | -1. The **development** version is of the form `x.0.z`, where `x` represents the |
15 | | - major version under development. Each release is performed by incrementing |
16 | | - `z`, the patch level, regardless of the type of changes. The development |
17 | | - version ends with the release of the "stable" version of `x.1.0`. The |
18 | | - development version is maintained on the `main` branch. |
19 | | -2. The **stable** version is of the form `x.y.z`, where `y >= 1`, and `x` is of |
20 | | - course the major version. The "stable" versions are the only ones which are |
21 | | - released to Oracle Linux as RPMs. Releases will generally increment `z`, the |
22 | | - patch version, for bug fix releases. It's possible that in rare cases, we |
23 | | - will increment `y` for backports, in cases where we want to backport a module |
24 | | - to the stable release. The stable version is maintained in a branch named |
25 | | - `stable/vX`, where `X` is replaced with the major version number (e.g. |
26 | | - `stable/v1`). |
27 | | - |
28 | | -The stable version is maintained in parallel as the development version is |
29 | | -developed. Fixes in the stable release must first be present in the development |
30 | | -release (and all newer stable releases, if applicable). |
31 | | - |
32 | | -For the most part, regular maintenance of the stable version will end with the |
33 | | -release of the next stable version, but maintenance may continue at our |
34 | | -discretion. |
35 | | - |
36 | | -Examples: |
37 | | - |
38 | | -- `1.1.0` - the initial public release of the `1.x` stable series. |
39 | | -- `1.1.1` - the first bugfix release of the `1.x` stable series. |
40 | | -- `2.0.0` - the initial development version of the `2.x`. |
41 | | -- `2.0.1` - an incremental development release in `2.x` development. It may |
42 | | - contain bug fixes or new features. |
43 | | -- `2.1.0` - the initial public release of the `2.x` stable series. |
44 | | - |
45 | | - |
46 | | -Unreleased |
47 | | ----------- |
48 | | - |
49 | | -Changes which are committed to git, but not yet released, may appear here. |
| 4 | +Development Model |
| 5 | +----------------- |
| 6 | + |
| 7 | +Development of drgn-tools happens on the `main` branch. Bug fixes and new |
| 8 | +features are committed there. Periodically, once we believe the set of features |
| 9 | +is ready to be released, we tag a new version for release. These new versions |
| 10 | +may increase the major or minor version of drgn-tools. Examples of these |
| 11 | +versions are: |
| 12 | + |
| 13 | +- 2.0.0 |
| 14 | +- 2.1.0 |
| 15 | +- 3.0.0 |
| 16 | + |
| 17 | +When bugs are found during the development of the next version of drgn-tools, we |
| 18 | +may backport them to the latest release in the form of a patch release. In that |
| 19 | +case, a stable branch would be created. For example, a bug in the 2.1.0 release |
| 20 | +would be backported into a branch named `stable/v2.1.x`, and a new patch release |
| 21 | +2.1.1 would be created. |
| 22 | + |
| 23 | +Stable branches are maintained only until the release of the next version. |
| 24 | + |
| 25 | +Periodically, we may create development builds for internal distribution. It is |
| 26 | +desirable for these builds to have a version number greater than any released |
| 27 | +version, but not yet incremented to the next major/minor version. In this case, |
| 28 | +we may set the patch version to "900" (and may increment it if multiple |
| 29 | +development releases are warranted). |
| 30 | + |
| 31 | +All changelogs since the 1.1.0 release can be found in the RPM packaging |
| 32 | +`%changelog` section, at `buildrpm/python-drgn-tools.spec`. Below are historical |
| 33 | +changelogs for reference. |
| 34 | + |
50 | 35 |
|
51 | 36 | 1.1.0 - Tue, Aug 27, 2023 |
52 | 37 | ------------------------- |
|
0 commit comments