You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: MAINTAINING.md
+6-10Lines changed: 6 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,24 +8,20 @@ The deprecation policy discussion is happening in [#3181](https://github.com/nix
8
8
9
9
## Releasing
10
10
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.
12
12
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.
14
14
15
15
Creating a stable branch may require temporarily disabling branch protection. This can only be done by an "admin" or "owner".
16
16
17
17
Once a stable branch is created, its flake inputs should be updated to point to the corresponding stable versions.
18
18
The branch can be created before these exist, in which case they should be updated when the corresponding stable inputs become available.
19
19
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
-
25
20
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.
26
21
27
-
### Deprecating old releases
22
+
### version-info
28
23
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.
30
26
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