Skip to content

Commit 8b67a22

Browse files
dcarleydcarley
authored
Merge branch 'main' into dcarley/merge-preview-main
2 parents 99759c3 + caf74f5 commit 8b67a22

File tree

5 files changed

+52
-107
lines changed

5 files changed

+52
-107
lines changed

‎.github/actions/common-setup/action.yml‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,13 @@ runs:
3030
using: "composite"
3131
steps:
3232
- name: "Setup Tailscale"
33-
uses: "tailscale/github-action@v2"
34-
if: ${{ inputs.TAILSCALE_URL && inputs.TAILSCALE_AUTH_KEY }}
33+
uses: "tailscale/github-action@v3"
34+
if: ${{ inputs.TAILSCALE_AUTH_KEY }}
3535
with:
36-
args: "--timeout 30s --login-server ${{ inputs.TAILSCALE_URL }}"
36+
oauth-secret: "${{ inputs.TAILSCALE_AUTH_KEY }}"
3737
tags: "tag:ci"
38-
authkey: "${{ inputs.TAILSCALE_AUTH_KEY }}"
38+
timeout: "30s"
39+
use-cache: true
3940

4041
- name: "Install newer Nix"
4142
uses: "cachix/install-nix-action@v24"
@@ -75,3 +76,6 @@ runs:
7576
cat $REMOTE_SERVER_USER_KNOWN_HOSTS_FILE
7677
echo "REMOTE_SERVER_ADDRESS=$REMOTE_SERVER_ADDRESS" >> $GITHUB_ENV
7778
echo "REMOTE_SERVER_USER_KNOWN_HOSTS_FILE=$REMOTE_SERVER_USER_KNOWN_HOSTS_FILE" >> $GITHUB_ENV
79+
if [ -n "$REMOTE_SERVER_ADDRESS" ]; then
80+
tailscale -- ping "$REMOTE_SERVER_ADDRESS"
81+
fi

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.cache/
22
.direnv/
33
site/
4-
include/
4+
/include/
55
docs/man
66
result
77
result-*

‎FLOX_VERSION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.7.4
1+
1.7.5

‎docs/include/replacing-a-Nix-installation.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!-- markdownlint-disable-file MD041 -->
2+
The Flox installer will perform some opinionated configuration of Nix, but Nix will still be usable.
3+
If you want full control of your Nix installation, see the instructions for installing Flox in the "Nix - Generic" tab above.
4+
5+
When installing over a previous installation of Nix the Flox installation
6+
will:
7+
8+
1. Back out customizations made to the following files when Nix was
9+
installed:
10+
* `/etc/bashrc`
11+
* `/etc/bash.bashrc`
12+
* `/etc/profile.d/nix.sh`
13+
* `/etc/zshrc`
14+
* `/etc/zsh/zshrc`
15+
1. Overwrite the system-wide `/etc/nix/nix.conf`
16+
1. (If applicable) convert the Nix installation to a multi-user install
17+
1. Reconfigure the `nix-daemon` invocation
18+
19+
These changes are designed to improve the overall user experience and make the Nix installation more reliable and easier to support, but it's worth noting that **anyone wishing to revert to a "vanilla" Nix installation after installing Flox will need to re-install Nix**.
20+
21+
If you are installing over a previous installation of Nix we suggest that you install Flox to a test machine or VM to gain familiarity with it first.
22+
23+
The version of Nix installed by Flox tracks the stable version of Nix in nixpkgs, occasionally adding additional backports or patches.
24+
Nix is usually updated monthly, although if Nix makes breaking changes, updates may be less frequent.

‎docs/install-flox/install.md‎

Lines changed: 18 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -18,27 +18,9 @@ description: How to install or upgrade the Flox CLI
1818
3. Open a terminal window to continue below
1919

2020
??? info "Replacing an existing Nix installation"
21-
22-
The Flox installer will perform some opinionated configuration of Nix, but Nix will still be usable.
23-
If you want full control of your Nix installation, see the instructions for installing Flox in the "Nix - Generic" tab above.
24-
25-
When installing over a previous installation of Nix the Flox installation
26-
will:
27-
28-
1. Back out customizations made to the following files when Nix was
29-
installed:
30-
* `/etc/bashrc`
31-
* `/etc/bash.bashrc`
32-
* `/etc/profile.d/nix.sh`
33-
* `/etc/zshrc`
34-
* `/etc/zsh/zshrc`
35-
2. Overwrite the system-wide `/etc/nix/nix.conf`
36-
3. (If applicable) convert the Nix installation to a multi-user install
37-
4. Reconfigure the `nix-daemon` invocation
38-
39-
These changes are designed to improve the overall user experience and make the Nix installation more reliable and easier to support, but it's worth noting that **anyone wishing to revert to a "vanilla" Nix installation after installing Flox will need to re-install Nix**.
40-
41-
If you are installing over a previous installation of Nix we suggest that you install Flox to a test machine or VM to gain familiarity with it first.
21+
{%
22+
include-markdown "include/replacing-a-Nix-installation.md"
23+
%}
4224

4325
**Verify Flox installation**
4426

@@ -72,27 +54,10 @@ description: How to install or upgrade the Flox CLI
7254

7355

7456
??? info "Replacing an existing Nix installation"
57+
{%
58+
include-markdown "include/replacing-a-Nix-installation.md"
59+
%}
7560

76-
The Flox installer will perform some opinionated configuration of Nix, but Nix will still be usable.
77-
If you want full control of your Nix installation, see the instructions for installing Flox in the "Nix - Generic" tab above.
78-
79-
When installing over a previous installation of Nix the Flox installation
80-
will:
81-
82-
1. Back out customizations made to the following files when Nix was
83-
installed:
84-
* `/etc/bashrc`
85-
* `/etc/bash.bashrc`
86-
* `/etc/profile.d/nix.sh`
87-
* `/etc/zshrc`
88-
* `/etc/zsh/zshrc`
89-
2. Overwrite the system-wide `/etc/nix/nix.conf`
90-
3. (If applicable) convert the Nix installation to a multi-user install
91-
4. Reconfigure the `nix-daemon` invocation
92-
93-
These changes are designed to improve the overall user experience and make the Nix installation more reliable and easier to support, but it's worth noting that **anyone wishing to revert to a "vanilla" Nix installation after installing Flox will need to re-install Nix**.
94-
95-
If you are installing over a previous installation of Nix we suggest that you install Flox to a test machine or VM to gain familiarity with it first.
9661

9762
**Verify Flox installation**
9863

@@ -134,27 +99,9 @@ description: How to install or upgrade the Flox CLI
13499
```
135100

136101
??? info "Replacing an existing Nix installation"
137-
138-
The Flox installer will perform some opinionated configuration of Nix, but Nix will still be usable.
139-
If you want full control of your Nix installation, see the instructions for installing Flox in the "Nix - Generic" tab above.
140-
141-
When installing over a previous installation of Nix the Flox installation
142-
will:
143-
144-
1. Back out customizations made to the following files when Nix was
145-
installed:
146-
* `/etc/bashrc`
147-
* `/etc/bash.bashrc`
148-
* `/etc/profile.d/nix.sh`
149-
* `/etc/zshrc`
150-
* `/etc/zsh/zshrc`
151-
1. Overwrite the system-wide `/etc/nix/nix.conf`
152-
1. (If applicable) convert the Nix installation to a multi-user install
153-
1. Reconfigure the `nix-daemon` invocation
154-
155-
These changes are designed to improve the overall user experience and make the Nix installation more reliable and easier to support, but it's worth noting that **anyone wishing to revert to a "vanilla" Nix installation after installing Flox will need to re-install Nix**.
156-
157-
If you are installing over a previous installation of Nix we suggest that you install Flox to a test machine or VM to gain familiarity with it first.
102+
{%
103+
include-markdown "include/replacing-a-Nix-installation.md"
104+
%}
158105

159106
**Verify Flox installation**
160107

@@ -199,27 +146,9 @@ description: How to install or upgrade the Flox CLI
199146
```
200147

201148
??? info "Replacing an existing Nix installation"
202-
203-
The Flox installer will perform some opinionated configuration of Nix, but Nix will still be usable.
204-
If you want full control of your Nix installation, see the instructions for installing Flox in the "Nix - Generic" tab above.
205-
206-
When installing over a previous installation of Nix the Flox installation
207-
will:
208-
209-
1. Back out customizations made to the following files when Nix was
210-
installed:
211-
* `/etc/bashrc`
212-
* `/etc/bash.bashrc`
213-
* `/etc/profile.d/nix.sh`
214-
* `/etc/zshrc`
215-
* `/etc/zsh/zshrc`
216-
1. Overwrite the system-wide `/etc/nix/nix.conf`
217-
1. (If applicable) convert the Nix installation to a multi-user install
218-
1. Reconfigure the `nix-daemon` invocation
219-
220-
These changes are designed to improve the overall user experience and make the Nix installation more reliable and easier to support, but it's worth noting that **anyone wishing to revert to a "vanilla" Nix installation after installing Flox will need to re-install Nix**.
221-
222-
If you are installing over a previous installation of Nix we suggest that you install Flox to a test machine or VM to gain familiarity with it first.
149+
{%
150+
include-markdown "include/replacing-a-Nix-installation.md"
151+
%}
223152

224153
**Verify Flox installation**
225154

@@ -287,7 +216,7 @@ description: How to install or upgrade the Flox CLI
287216
nix profile install \
288217
--experimental-features "nix-command flakes" \
289218
--accept-flake-config \
290-
'github:flox/flox'
219+
'github:flox/flox/latest'
291220
```
292221

293222
* Install Flox to the system-wide `default` profile as root:
@@ -297,7 +226,7 @@ description: How to install or upgrade the Flox CLI
297226
--profile /nix/var/nix/profiles/default \
298227
--experimental-features "nix-command flakes" \
299228
--accept-flake-config \
300-
'github:flox/flox'
229+
'github:flox/flox/latest'
301230
```
302231
??? info "On error"
303232

@@ -364,7 +293,7 @@ description: How to install or upgrade the Flox CLI
364293
inputs.nixpkgs.follows = "nixpkgs";
365294
};
366295
flox = {
367-
url = "github:flox/flox/v{{ FLOX_VERSION }}";
296+
url = "github:flox/flox/latest";
368297
};
369298
};
370299

@@ -437,19 +366,7 @@ description: How to install or upgrade the Flox CLI
437366
'.*flox'
438367
```
439368

440-
Or, if you've declared Flox using a flake, update the version in the flake
441-
442-
``` { .sh .code-command .copy }
443-
...
444-
flox = {
445-
url = "github:flox/flox/v{{ FLOX_VERSION }}";
446-
};
447-
...
448-
```
449-
450-
Nix does not always update transitive dependencies when the version is
451-
changed,
452-
so to ensure all updates are applied, run `nix flake update`.
369+
Or, if you've declared Flox using a flake, run `nix flake update`.
453370

454371
=== "Nix - NixOS"
455372

@@ -476,7 +393,7 @@ description: How to install or upgrade the Flox CLI
476393
nix profile install \
477394
--experimental-features "nix-command flakes" \
478395
--accept-flake-config \
479-
'github:flox/flox'
396+
'github:flox/flox/latest'
480397
```
481398

482399
* Install Flox to the system-wide `default` profile as root:
@@ -486,7 +403,7 @@ description: How to install or upgrade the Flox CLI
486403
--profile /nix/var/nix/profiles/default \
487404
--experimental-features "nix-command flakes" \
488405
--accept-flake-config \
489-
'github:flox/flox'
406+
'github:flox/flox/latest'
490407
```
491408

492409
??? info "On error"

0 commit comments

Comments
 (0)