Skip to content

Commit 3843b62

Browse files
committed
maintaining: update to reflect version-info
1 parent a41559f commit 3843b62

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

MAINTAINING.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,20 @@ The deprecation policy discussion is happening in [#3181](https://github.com/nix
88

99
## Releasing
1010

11-
Nixvim releases stable versions in sync with nixpkgs. A YY.05 version is released in May and a YY.11 version is released in November.
11+
Nixvim releases stable versions in sync with nixpkgs. A _`YY.05`_ version is released in May and a _`YY.11`_ version is released in November.
1212

13-
We do not need to wait for the release to be "stable" before creating a branch, however we _should_ wait before updating links and references on the `main` branch.
13+
We do not need to wait for the release to come out of _“beta”_ before creating a branch, however we _should_ wait before updating links and references on the `main` branch.
1414

1515
Creating a stable branch may require temporarily disabling branch protection. This can only be done by an "admin" or "owner".
1616

1717
Once a stable branch is created, its flake inputs should be updated to point to the corresponding stable versions.
1818
The branch can be created before these exist, in which case they should be updated when the corresponding stable inputs become available.
1919

20-
Once a stable branch is created, it should be added to the `update-other` workflow on the `main` branch.
21-
22-
Once a stable branch is considered "public", it should be added to the `build_documentation` workflow on the `main` branch.
23-
This can be done while the version is still "beta".
24-
2520
Once a stable version is considered "out of beta", references to Nixvim's stable branch should be updated on the `main` branch to reference the new version.
2621

27-
### Deprecating old releases
22+
### version-info
2823

29-
Once a stable branch is deprecated, it should be removed from the `update-other` workflow on the `main` branch.
24+
The `update` workflow will automatically add info about stable branches to `version-info.toml`.
25+
This is used by CI workflows like `update-other` and `website` to automatically list supported stable versions.
3026

31-
It should also be removed from the `build_documentation` workflow on the `main` branch.
27+
This should usually be handled automatically, however errors may show up if a version is added to `version-info.toml` before the corresponding Nixvim branch exists.

0 commit comments

Comments
 (0)