Skip to content

Commit 2f610f9

Browse files
committed
maintaining: initial "Releasing" section
1 parent 1350e87 commit 2f610f9

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

MAINTAINING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,27 @@ This file is intended as a reference for Nixvim's core maintainers, although it
55
## Deprecation
66

77
The deprecation policy discussion is happening in [#3181](https://github.com/nix-community/nixvim/issues/3181).
8+
9+
## Releasing
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.
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.
14+
15+
Creating a stable branch may require temporarily disabling branch protection. This can only be done by an "admin" or "owner".
16+
17+
Once a stable branch is created, its flake inputs should be updated to point to the corresponding stable versions.
18+
The branch can be created before these exist, in which case they should be updated when the corresponding stable inputs become available.
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+
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+
27+
### Deprecating old releases
28+
29+
Once a stable branch is deprecated, it should be removed from the `update-other` workflow on the `main` branch.
30+
31+
It should also be removed from the `build_documentation` workflow on the `main` branch.

0 commit comments

Comments
 (0)