Document nixpkgs/NixOS compatibility

[nh2]

It would be great if releases of microvm.nix could document with which nixpkgs/NixOS releases they are compatible (e.g. 24.11, 25.05, 25.11, etc).

[SuperSandro2000]

We did not do a tag since close two years now. Not sure if they are so great to use.

For supported Nixpkgs thats always the currented supported ones upstream.

[nh2]

For supported Nixpkgs thats always the currented supported ones upstream.

But for any given historical commit I can also not see which nixpkgs is supported.

For example, which version (tagged or not) supports 24.05? Difficult to tell.

Tags are not needed to do this, it would be sufficient if README kept a simple statement what the current supported release is.

Alternatively, if there's a CI that runs to check what it's compatible with, that would also be enough to point out in the README so that the user can look there.

---

Even today the state is a bit confusing. There's a file prebuilt-25.05.yml but its contents are name: "prebuilt-25.11".

[SuperSandro2000]

For example, which version (tagged or not) supports 24.05? Difficult to tell.

see https://github.com/microvm-nix/microvm.nix/commits/main/.github/workflows , so 6c2123b would be the last commit.

Tags are not needed to do this, it would be sufficient if README kept a simple statement what the current supported release is.

As you already pointed out, we cannot even keep the CI file name in sync with its actual content. 😅

---

I have such a supported version noted NixOS WSL and the shear amount of issues I get there about "adding" support (often just bumping some string) for some newer version or that some release for a newer version is missing despite the current HEAD working totally fine, but users did not even try if it could work. If @astro wants to add and maintain please go ahead, but I don't want to maintain it myself due to the lack of time on my end to also update that when there is a new release.

[nh2]

@SuperSandro2000 Then I think it's best to state the approach in the README, e.g.

This project aims to support the current NixOS release. There are no tagged releases, but our CI runs regularly against the most recent stable NixOS release and nixos-unstable. You can determine on which nixpkgs commit the CI succeeded by looking at its output (example).