mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-26 18:58:43 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

maintaining: update to reflect version-info

Browse source
This commit is contained in:
Matt Sturgeon 2025-06-22 21:45:58 +01:00
parent a41559f093
commit 3843b62261
1 changed files with 6 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

16
MAINTAINING.md
View file

@ -8,24 +8,20 @@ The deprecation policy discussion is happening in [#3181](https://github.com/nix
## Releasing ## Releasing
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. 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.
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. 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.
Creating a stable branch may require temporarily disabling branch protection. This can only be done by an "admin" or "owner". Creating a stable branch may require temporarily disabling branch protection. This can only be done by an "admin" or "owner".
Once a stable branch is created, its flake inputs should be updated to point to the corresponding stable versions. Once a stable branch is created, its flake inputs should be updated to point to the corresponding stable versions.
The branch can be created before these exist, in which case they should be updated when the corresponding stable inputs become available. The branch can be created before these exist, in which case they should be updated when the corresponding stable inputs become available.
Once a stable branch is created, it should be added to the `update-other` workflow on the `main` branch.
Once a stable branch is considered "public", it should be added to the `build_documentation` workflow on the `main` branch.
This can be done while the version is still "beta".
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. 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.
### Deprecating old releases ### version-info
Once a stable branch is deprecated, it should be removed from the `update-other` workflow on the `main` branch. The `update` workflow will automatically add info about stable branches to `version-info.toml`.
This is used by CI workflows like `update-other` and `website` to automatically list supported stable versions.
It should also be removed from the `build_documentation` workflow on the `main` branch. 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.