Sync with upstream

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+# options for shfmt(1)
+binary_next_line = true
+switch_case_indent = true

.envrc

@@ -0,0 +1,4 @@
+watch_file devenv.nix 
+watch_file devenv.yaml 
+watch_file devenv.lock
+eval "$(devenv print-dev-env)"

.github/dependabot.yaml

@@ -0,0 +1,9 @@
+# Set update schedule for GitHub Actions
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+

.github/workflows/issue-notifier.yml

@@ -8,9 +8,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: issue-notifier
-        uses: timheuer/[email protected].2
+        uses: timheuer/[email protected].4
         env:
           SENDGRID_API_KEY: ${{ secrets.SENDGRID_API_KEY }}
         with:

.github/workflows/main.yml

@@ -21,7 +21,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout source code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Install dependencies
         run: |
           # Get Nix
@@ -32,6 +32,7 @@ jobs:
 
           echo "/nix/var/nix/profiles/per-user/runner/profile/bin" >> $GITHUB_PATH
           echo "/nix/var/nix/profiles/default/bin" >> $GITHUB_PATH
+          echo "${HOME}/.nix-profile/bin" >> $GITHUB_PATH
 
           source "${HOME}/.nix-profile/etc/profile.d/nix.sh"
           # Install dependencies

.gitignore

@@ -0,0 +1,5 @@
+
+# Devenv
+.devenv*
+devenv.local.nix
+

README.adoc

@@ -1,16 +1,16 @@
-= niv-updater: Automated dependency updates with niv 
+= niv-updater: Automated dependency updates with niv
 
-image:https://github.com/knl/niv-updater-action/workflows/CI/badge.svg[CI]
+image:https://github.com/knl/niv-updater-action/actions/workflows/main.yml/badge.svg[CI]
 image:https://img.shields.io/github/v/release/knl/niv-updater-action[GitHub release (latest by date)]
 
-This action will open a pull request to master branch (or otherwise specified
+This action will open a pull request to `master` branch (or otherwise specified
 branch) whenever https://github.com/nmattia/niv[niv] detects updates to
 `nix/sources.json` in your repository, for each dependency separately. Each PR
 will contain a beautiful Changelog of all the changes in the update, like this:
 
 image:./assets/niv-update-action-changelog.png[title="Changelog generated by niv-updater-action]
 
-The best way to use niv-updater-action is to set up a scheduled workflow. This
+The best way to use `niv-updater-action` is to set up a scheduled workflow. This
 way, whenever there are new updates, you will get a PR that you can just
 approve and avoid a lot of manual work.
 
@@ -34,7 +34,7 @@ jobs:
     steps:
       # notice there is no checkout step
       - name: niv-updater-action
-        uses: knl/niv-updater-action@v9
+        uses: knl/niv-updater-action@v15
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ----
@@ -53,13 +53,14 @@ jobs:
   This value will be passed to niv via `--sources-file` option. Defaults to
   `nix/sources.json`.
 * `niv_version`: (Optional) The niv version to be used. Defaults to `master`,
-  meaning niv-updater-action will take the latest niv for each run. You may want
-  to fix a particular version and avoid future breaks to your workflow.
+  meaning `niv-updater-action` will take the latest niv for each run. You may want
+  to fix a particular version and avoid future breaks to your workflow. If you're
+  using a self-hosted runner, set this to `*from-nixpkgs*`.
 * `branch_prefix`: (Optional) The prefix used for update branches, created by
   this action. The action does not sanitize the branch name. For a description
   of what a valid branch name is, please consult:
   https://mirrors.edge.kernel.org/pub/software/scm/git/docs/git-check-ref-format.html.
-  Defaults to "update/".
+  Defaults to `update/`.
 * `keep_updating`: (Optional) If PR already exists, keep it updated with new
   changes. The branch will be force updated, as this process keeps a single
   commit on a branch. Defaults to `false` to maintain the old behaviour.
@@ -101,12 +102,12 @@ jobs:
   https://github.com/knl/niv-updater-action/issues/26[Issue #26]. Defaults to
   `true`.
 * `debug_output`: (Optional, a boolean) If `true`, `set -x` will be turned on
-  for the updater script, outputing every step the action takes. This will show
+  for the updater script, outputting every step the action takes. This will show
   up in the action log, and could be useful for trying to reproduce issues
   locally. Defaults to `false`.
 
 As the above list suggests, `niv-updater-action` is highly configurable.
-The following example exposes some of the nobs, many with their default values:
+The following example exposes some of the knobs, many with their default values:
 
 [source,yaml]
 ----
@@ -123,7 +124,7 @@ jobs:
     steps:
       # notice there is no checkout step
       - name: niv-updater-action
-        uses: knl/niv-updater-action@v9
+        uses: knl/niv-updater-action@v15
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
@@ -165,3 +166,37 @@ Actions workflow YAML file.
 
 * `GITHUB_TOKEN` - (Required) The GitHub API token used to create pull requests
   and get content from all repositories tracked by `niv`.
+
+== Self hosted runner
+
+Self-hosted runners are running with dynamic users so nix profile is not
+accessible, as well as nix-env. As this action relies on nix-env to install
+niv, the default configuration will not work. Thus, to use niv from available
+nixpkgs, set `niv_version` to `pass:[*from-nixpkgs*]`. It will install `niv`
+using `nixpkgs` with nix-shell instead of nix-env.
+
+To avoid using `sudo` (also unavailable on self-hosted runners), the input
+`pass:[skip_ssh_repos]` should be set to `true`.
+
+Example:
+
+[source,yaml]
+----
+name: Automated niv-managed dependency updates
+on:
+  schedule:
+    # * is a special character in YAML so you have to quote this string
+    # run this every day at 4:00am
+    - cron:  '0 4 * * *'
+jobs:
+  niv-updater:
+    name: 'Create PRs for niv-managed dependencies'
+    runs-on: self-hosted
+    steps:
+      # notice there is no checkout step
+      - name: niv-updater-action
+        uses: knl/niv-updater-action@v15
+        with:
+          niv_version: '*from-nixpkgs*'
+          skip_ssh_repos: true
+----

action.yml

@@ -2,7 +2,7 @@ name: 'niv Updater Action'
 description: 'A GitHub action that detects updates to dependencies tracked by niv and creates pull requests to keep them up to date.'
 author: 'knl'
 runs:
-  using: 'node12'
+  using: 'node20'
   main: 'main.js'
 inputs:
   pull_request_base:

devenv.lock

@@ -0,0 +1,116 @@
+{
+  "nodes": {
+    "devenv": {
+      "locked": {
+        "dir": "src/modules",
+        "lastModified": 1729087493,
+        "owner": "cachix",
+        "repo": "devenv",
+        "rev": "d612b77ff73912cd82e58256ab5e84d5904abef7",
+        "type": "github"
+      },
+      "original": {
+        "dir": "src/modules",
+        "owner": "cachix",
+        "repo": "devenv",
+        "type": "github"
+      }
+    },
+    "flake-compat": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1696426674,
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "gitignore": {
+      "inputs": {
+        "nixpkgs": [
+          "pre-commit-hooks",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1709087332,
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "rev": "637db329424fd7e46cf4185293b9cc8c88c95394",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1728979988,
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "7881fbfd2e3ed1dfa315fca889b2cfd94be39337",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixpkgs-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs-stable": {
+      "locked": {
+        "lastModified": 1728909085,
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "c0b1da36f7c34a7146501f684e9ebdf15d2bebf8",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-24.05",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "pre-commit-hooks": {
+      "inputs": {
+        "flake-compat": "flake-compat",
+        "gitignore": "gitignore",
+        "nixpkgs": [
+          "nixpkgs"
+        ],
+        "nixpkgs-stable": "nixpkgs-stable"
+      },
+      "locked": {
+        "lastModified": 1729104314,
+        "owner": "cachix",
+        "repo": "pre-commit-hooks.nix",
+        "rev": "3c3e88f0f544d6bb54329832616af7eb971b6be6",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "pre-commit-hooks.nix",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "devenv": "devenv",
+        "nixpkgs": "nixpkgs",
+        "pre-commit-hooks": "pre-commit-hooks"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

devenv.nix

@@ -0,0 +1,27 @@
+{ pkgs, ... }:
+
+{
+  # https://devenv.sh/basics/
+  # env.GREET = "devenv";
+
+  # https://devenv.sh/packages/
+  packages = [ pkgs.asciidoctor ];
+
+  # enterShell = ''
+  # '';
+
+  # https://devenv.sh/languages/
+  # languages.nix.enable = true;
+
+  # https://devenv.sh/scripts/
+  # scripts.hello.exec = "echo hello from $GREET";
+
+  # https://devenv.sh/pre-commit-hooks/
+  pre-commit.hooks.shellcheck.enable = true;
+  pre-commit.hooks.actionlint.enable = true;
+  pre-commit.hooks.shfmt.enable = true;
+  # pre-commit.hooks.typos.enable = true;
+
+  # https://devenv.sh/processes/
+  # processes.ping.exec = "ping example.com";
+}

devenv.yaml

@@ -0,0 +1,4 @@
+inputs:
+  nixpkgs:
+    url: github:NixOS/nixpkgs/nixpkgs-unstable
+# can't point to the local modules here as it's used as a template