Skip to content

Commit

Permalink
feat(worfklows): rename jobs and structure
Browse files Browse the repository at this point in the history
  • Loading branch information
erikreinert committed Dec 2, 2023
1 parent 0b0bf95 commit 449ac32
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 21 deletions.
16 changes: 7 additions & 9 deletions .github/workflows/test-darwin.yml
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
---
name: 'Test Darwin Flake Template'
name: 'Test Darwin Template'

on:
push:
branches: [main]
pull_request:
push:
branches:
- main

jobs:
build-nixos-deriv:
name: 'Build Darwin template derivation'
build:
runs-on: macos-latest
steps:
- uses: DeterminateSystems/nix-installer-action@main
- uses: DeterminateSystems/magic-nix-cache-action@main
- uses: actions/checkout@v3
- uses: cachix/install-nix-action@v22
with:
nix_path: nixpkgs=channel:nixos-unstable
- run: bash hack/test-darwin.sh
5 changes: 3 additions & 2 deletions .github/workflows/test-nixos.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
name: 'Test NixOS Flake Template(s)'
name: 'Test NixOS Template(s)'

on:
pull_request:
push:
branches: [main]
branches:
- main

jobs:
build:
Expand Down
38 changes: 28 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ Kickstart your Nix environment.
- [Go](#go)
- Systems
- [macOS](#macos)
- [nixOS](#nixos)
- [NixOS (minimal)](#nixos-minimal)
- [NixOS (GNOME)](#nixos-gnome)
- Guides
- [Setup macOS](#setup-macos)
- [Setup NixOS](#setup-nixos)
Expand All @@ -33,10 +34,26 @@ nix flake init --template github:ALT-F4-LLC/kickstart.nix#go
nix flake init --template github:ALT-F4-LLC/kickstart.nix#macos
```

#### NixOS
#### NixOS minimal

The NixOS minimal installer includes the base operating system without any windows manager.

> [!NOTE]
> This setup is ideal for servers and other headless tasks.
```bash
nix flake init --template github:ALT-F4-LLC/kickstart.nix#nixos-minimal
```

#### NixOS GNOME

The NixOS GNOME installer includes the base operating sytsem with GNOME windows manager included.

> [!NOTE]
> This setup is ideal for getting started moving to NixOS as your main desktop.
```bash
nix flake init --template github:ALT-F4-LLC/kickstart.nix#nixos
nix flake init --template github:ALT-F4-LLC/kickstart.nix#nixos-gnome
```

### Guides
Expand Down Expand Up @@ -138,7 +155,9 @@ cd ~/kickstart.nix
5. Using `nix flake init` generate the `kickstart.nix` template locally:

```bash
nix flake init --template github:ALT-F4-LLC/kickstart.nix#nixos
nix flake init --template github:ALT-F4-LLC/kickstart.nix#nixos-gnome # desktop
nix flake init --template github:ALT-F4-LLC/kickstart.nix#nixos-minimal # headless
nix flake init --template github:ALT-F4-LLC/kickstart.nix#nixos-plasma # desktop
```

6. Update the following value(s) in `flake.nix` configuration:
Expand All @@ -156,18 +175,17 @@ in
7. Switch to `kickstart.nix` environment for your system with flake configuration:

```bash
sudo nixos-rebuild test --flake ".#aarch64" # M Series Chipsets
sudo nixos-rebuild switch --flake ".#aarch64" # M Series Chipsets
sudo nixos-rebuild test --flake ".#aarch64" --impure # M Series Chipsets
sudo nixos-rebuild switch --flake ".#aarch64" --impure # M Series Chipsets

sudo nixos-rebuild test --flake ".#x86_64" # Intel Chipsets
sudo nixos-rebuild switch --flake ".#x86_64" # Intel Chipsets
sudo nixos-rebuild test --flake ".#x86_64" --impure # Intel Chipsets
sudo nixos-rebuild switch --flake ".#x86_64" --impure # Intel Chipsets
```

Congrats! You've setup NixOS with Home Manager!

Be sure to explore the files below to get started customizing:

- `system/hardware-configuration.nix` for `NixOS` hardware related settings
- `system/nixos.nix` for `NixOS` system related settings
- `module/configuration.nix` for more `NixOS` system related settings
- `module/home-manager.nix` for `Home Manager` related settings
- `system/nixos.nix` for `NixOS` system related settings

0 comments on commit 449ac32

Please sign in to comment.