Merge pull request #17 from Profiidev/feat/action

Author: Profiidev

.github/workflows/auto-merge-flake-updates.yml

@@ -0,0 +1,19 @@
+name: Auto Merge PR with Flake Lock Update
+
+on:
+  pull_request:
+    types:
+      - labeled
+
+jobs:
+  merge:
+    if: ${{ github.event.label.name == 'flake-lock-update' && github.event.pull_request.user.login == 'Profiidev' }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+      - name: Enable auto-merge for PR
+        run: gh pr merge ${{ github.event.pull_request.number }} --auto --squash
+        env:
+          GITHUB_TOKEN: ${{ secrets.PERSONAL_TOKEN }}
+          GITHUB_REPOSITORY: ${{ github.repository }}

.github/workflows/create-release.yml

@@ -29,3 +29,11 @@ jobs:
         run: |
           git tag -f latest
           git push origin -f latest
+
+      - name: Update major tag
+        run: |
+          VERSION=${{ github.event.pull_request.head.ref }}
+          VERSION=${VERSION#chore/release-version-}
+          MAJOR_VERSION=$(echo $VERSION | cut -d. -f1)
+          git tag -f "$MAJOR_VERSION"
+          git push origin -f "$MAJOR_VERSION"

.github/workflows/flake-lock-update.yml

@@ -0,0 +1,30 @@
+name: Lock Update
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * 1" # Every Monday at midnight UTC
+
+jobs:
+  update-components:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+      - uses: cachix/install-nix-action@v31
+
+      - name: Update components
+        run: |
+          nix flake update
+
+      - name: Create PR
+        uses: peter-evans/create-pull-request@v8
+        with:
+          token: ${{ secrets.PERSONAL_TOKEN }}
+          commit-message: "chore: updated flake lock"
+          branch: "chore/update-flake-lock-${{ github.run_id }}"
+          title: "chore: update flake lock"
+          body: "This PR updates the flake inputs to the latest versions."
+          base: main
+          sign-commits: true
+          labels: flake-lock-update

.github/workflows/release-trigger.yml

@@ -17,6 +17,7 @@ jobs:
           token: ${{ secrets.PERSONAL_TOKEN }}
         uses: actions/checkout@v6
       - uses: dtolnay/rust-toolchain@stable
+      - uses: bahmutov/npm-install@v1
 
       - name: Update version
         id: update_version
@@ -29,6 +30,7 @@ jobs:
           sed -i "s/version = \".*\"/version = \"$NEW_VERSION\"/" flake.nix
           cargo metadata -q
           cd frontend && npm version $NEW_VERSION --no-git-tag-version
+          cd ../actions && npm version $NEW_VERSION --no-git-tag-version && npm run build
 
       - name: Create PR
         uses: peter-evans/create-pull-request@v8

.github/workflows/test-action.yml

@@ -0,0 +1,35 @@
+name: Test Setup Action
+on:
+  pull_request:
+
+jobs:
+  test-setup:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+          - ubuntu-24.04-arm
+          - macos-latest
+        version:
+          - v0.1.0
+          - latest
+    name: Test Setup Action on ${{ matrix.os }} with version ${{ matrix.version }}
+    steps:
+      - uses: actions/checkout@v6
+      - name: Setup Cli
+        uses: ./
+        with:
+          version: ${{ matrix.version }}
+
+      - name: Verify Installation
+        if: matrix.version != 'latest'
+        run: |
+          RAW_VERSION=${{ matrix.version }}
+          VERSION="${RAW_VERSION#v}"
+          hibernation --version | grep $VERSION
+
+      - name: Verify Latest Installation
+        if: matrix.version == 'latest'
+        run: |
+          hibernation --version

README.md

@@ -53,12 +53,33 @@ See `backend/src/config.rs` for all non-standard configuration options.
 
 The CLI tool allows you to interact with the Hibernation server, primarily for authenticating and pushing Nix store paths.
 
-You can install it from the binaries published to GitHub Releases or using Cargo:
+You can install it from the binaries published to GitHub Releases, using Cargo:
 
 ```bash
 cargo install --git https://github.com/ProfiiDev/hibernation hibernation
 ```
 
+Or in you nix config:
+
+```nix
+{
+  inputs = {
+    ...
+    hibernation.url = "github:profiidev/hibernation/latest";
+  }
+  ...
+}
+```
+
+```nix
+{ inputs, pkgs, ... }:
+{
+  environment.systemPackages = with pkgs; [
+    inputs.hibernation.packages.${stdenv.hostPlatform.system}.default
+  ];
+}
+```
+
 ### Pushing Nix Store Paths
 
 1. To push a Nix store path to the Hibernation server you first need a signing key pair. You can generate a new secret key using the following command:
@@ -77,7 +98,7 @@ cargo install --git https://github.com/ProfiiDev/hibernation hibernation
 
 4. Use the following command from the cli to push paths (all missing configuration will be prompted for):
    ```bash
-   hibernation push /nix/store/your-store-path
+   hibernation push <cache-name> /nix/store/your-store-path
    ```
 
 ## Deployment
@@ -111,7 +132,9 @@ Once running, the services will be available at:
 
 ## TODO
 
-- cli flake install docs
-- github action for cache and cli setup
+- nix api support byte range queries
+- move url setting from frontend to env var and document in readme
+- add support for virtual host based cache access (requires more restrictions on cache names)
+- document action usage in readme
 - add overview page in frontend
 - nix store watch mode in cli + auto push + example in cache page

action.yml

@@ -0,0 +1,12 @@
+name: Hibernation setup
+description: Setup Hibernation CLI
+
+inputs:
+  version:
+    description: The version of Hibernation CLI to install
+    required: true
+    default: latest
+
+runs:
+  using: node24
+  main: action/dist/index.js

action/.gitignore

@@ -0,0 +1 @@
+/dist/index.js.map