Skip to content

doc/src/installation: note master branch follows rolling-release model #2116

Merged
0xda157 merged 1 commit intonix-community:masterfrom
0xda157:update-hm-nixpkgs
Jan 31, 2026
Merged

doc/src/installation: note master branch follows rolling-release model #2116
0xda157 merged 1 commit intonix-community:masterfrom
0xda157:update-hm-nixpkgs

Conversation

@0xda157
Copy link
Copy Markdown
Contributor

@0xda157 0xda157 commented Dec 31, 2025

this has been a consistent issue people have been running into and reporting bugs about (e.g. #2114), so we should probably warn people in the documentation.


@stylix-automation stylix-automation bot added the topic: documentation Documentation additions or improvements label Dec 31, 2025
Copy link
Copy Markdown
Member

@trueNAHO trueNAHO left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about this:

From b237060bae07d0e55ed0db5a37379ac48027ee3b Mon Sep 17 00:00:00 2001
From: NAHO <90870942+trueNAHO@users.noreply.github.com>
Date: Tue, 6 Jan 2026 00:16:58 +0100
Subject: [PATCH] doc/src/installation: note master branch follows
 rolling-release model

Note that the master branch follows a rolling-release model, as version
mismatches are a common source of issues.

Link: https://github.com/nix-community/stylix/pull/2116

Co-authored-by: 0xda157 <da157@voidq.com>
---
 doc/src/installation.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/doc/src/installation.md b/doc/src/installation.md
index d86b9171..1463f2e2 100644
--- a/doc/src/installation.md
+++ b/doc/src/installation.md
@@ -1,5 +1,15 @@
 # Installation

+> [!IMPORTANT]
+> The master (unstable) branch of Stylix follows a rolling-release model. To
+> ensure compatibility, all inputs must be kept in sync.
+>
+> Avoid partial updates and always update inputs together with:
+>
+> ```console
+> nix flake update
+> ```
+
 ## NixOS

 You can install Stylix into your NixOS configuration using [Flakes][nix-flakes].
--
2.51.2

This is what this looks like:

Image

@0xda157 0xda157 force-pushed the update-hm-nixpkgs branch from a19b7dc to f3586ba Compare January 7, 2026 16:56
@0xda157 0xda157 changed the title doc: add warning about updating nixpkgs, etc while installing doc/src/installation: note master branch follows rolling-release model Jan 7, 2026
Comment thread doc/src/installation.md Outdated
Copy link
Copy Markdown
Member

@trueNAHO trueNAHO left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

Since the rolling-release model applies to all branches, should we make it more generic:

> Stylix follows a rolling-release model. To ensure compatibility, all inputs
> must be kept in sync.

Also, we might want to add the word "version" in the second sentence:

> Stylix follows a rolling-release model. To ensure version compatibility, all
> inputs must be kept in sync.

-- #2116 (comment)

I rebased this PR on top of master and applied those changes. Feel free to merge this PR if those changes are fine with you.

@trueNAHO trueNAHO changed the title doc/src/installation: note master branch follows rolling-release model doc/src/installation: document rolling-release model Jan 8, 2026
Comment thread doc/src/installation.md Outdated
Note that the master branch follows a rolling-release model, as version
mismatches are a common source of issues.

Link: nix-community#2116

Co-authored-by: 0xda157 <da157@voidq.com>
Copy link
Copy Markdown
Member

@trueNAHO trueNAHO left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On a side note, it would be great to document our backport policy somewhere so it can be linked in the following:

- [ ] Each commit in this PR is suitable for backport to the current stable branch

@trueNAHO trueNAHO changed the title doc/src/installation: document rolling-release model doc/src/installation: note master branch follows rolling-release model Jan 14, 2026
@trueNAHO trueNAHO added the backport: release-25.11 To be backported to the release-25.11 stable branch label Jan 20, 2026
@trueNAHO trueNAHO mentioned this pull request Jan 29, 2026
6 tasks
@0xda157 0xda157 merged commit 8b14679 into nix-community:master Jan 31, 2026
5 checks passed
@0xda157 0xda157 deleted the update-hm-nixpkgs branch January 31, 2026 00:39
stylix-automation bot pushed a commit that referenced this pull request Jan 31, 2026
#2116)

Link: #2116

Co-authored-by: NAHO <90870942+trueNAHO@users.noreply.github.com>
(cherry picked from commit 8b14679)
@stylix-automation
Copy link
Copy Markdown
Contributor

Successfully created backport PR for release-25.11:

@github-actions github-actions bot added the has: port to stable This has been backported to the latest stable branch label Jan 31, 2026
0xda157 added a commit that referenced this pull request Jan 31, 2026
#2116)

Link: #2116

Co-authored-by: NAHO <90870942+trueNAHO@users.noreply.github.com>
(cherry picked from commit 8b14679)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport: release-25.11 To be backported to the release-25.11 stable branch has: port to stable This has been backported to the latest stable branch topic: documentation Documentation additions or improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants