Fix conflicts with main

README.md

@@ -138,6 +138,23 @@ jobs:
           path-to-flake-dir: 'nix/' # in this example our flake doesn't sit at the root of the repository, it sits under 'nix/flake.nix'
 ```
 
+You can also run the update operation in multiple directories, provided that each directory is a valid flake:
+
+```yaml
+- name: Update flake.lock
+  uses: DeterminateSystems/update-flake-lock@vX
+  with:
+    flake-dirs: |
+      flake1
+      flake2
+      flake3
+```
+
+> **Warning**: If you choose multiple directories, `update-flake-lock` can only update all flake inputs,
+> meaning that you can't set the `inputs` parameter. This is due to limitations in input handling in
+> GitHub Actions, which only allows for strings, numbers, Booleans, and arrays but not objects, which
+> would be the much preferred data type for expressing per-directory inputs.
+
 ## Example using a different Git user
 
 If you want to change the author and / or committer of the flake.lock update commit, you can tweak the `git-{author,committer}-{name,email}` options:
@@ -185,7 +202,7 @@ git push origin update_flake_lock_action --force
 ### With a Personal Authentication Token
 
 By providing a Personal Authentication Token, the PR will be submitted in a way that bypasses this limitation (GitHub will essentially think it is the owner of the PAT submitting the PR, and not an Action).
-You can create a token by visiting https://github.com/settings/tokens and select at least the `repo` scope. For the new fine-grained tokens, you need to enable read and write access for "Contents" and "Pull Requests" permissions. Then, store this token in your repository secrets (i.e. `https://github.com/<USER>/<REPO>/settings/secrets/actions`) as `GH_TOKEN_FOR_UPDATES` and set up your workflow file like the following:
+You can create a token by visiting https://github.com/settings/tokens and select at least the `repo` scope. Then, store this token in your repository secrets (i.e. `https://github.com/<USER>/<REPO>/settings/secrets/actions`) as `GH_TOKEN_FOR_UPDATES` and set up your workflow file like the following:
 
 ```yaml
 name: update-flake-lock

action.yml

@@ -9,10 +9,21 @@ inputs:
     description: "GITHUB_TOKEN or a `repo` scoped Personal Access Token (PAT)"
     required: false
     default: ${{ github.token }}
-  commit-msg:
-    description: "The message provided with the commit"
+  commit-msg-template:
+    description: |
+      The commit message template to use. You can use these variables in your template:
+
+      * `{{ flake_dot_lock }}` is the path to the `flake.lock` file being updated
+      * `{{ flake_dot_lock_dir }}` is the `flake.lock` file's directory
+
+      If you set both this and `commit-msg`, the `commit-msg` setting is used (it does not support templating).
+    required: false
+    default: |
+      flake.lock: Updated in {{ flake_dot_lock_dir }}
+  commit-msg:
+    description: |
+      The message provided with the commit.
     required: false
-    default: "flake.lock: Update"
   base:
     description: "Sets the pull request base branch. Defaults to the branch checked out in the workflow."
     required: false
@@ -21,12 +32,32 @@ inputs:
     required: false
     default: "update_flake_lock_action"
   path-to-flake-dir:
-    description: "The path of the directory containing `flake.nix` file within your repository. Useful when `flake.nix` cannot reside at the root of your repository."
+    description: |
+      The path of the directory containing `flake.nix` file within your repository.
+      Useful when `flake.nix` cannot reside at the root of your repository.
     required: false
+  flake-dirs:
+    description: |
+      A space-separated list of directories containing `flake.nix` files within your repository.
+      Useful when you have multiple flakes in your repository.
+    required: false
+    default: ""
   pr-title:
     description: "The title of the PR to be created"
     required: false
     default: "flake.lock: Update"
+  pr-body-template:
+    description: |
+      The pull request body template to use. You can use these variables in your template:
+
+      * `{{ comma_separated_dirs }}` is the flake directories that were updated separated by comma
+      * `{{ space_separated_dirs }}` is the flake directories that were updated separated by space
+      * `{{ updated_dirs_list }}` is the flake directories that were updated as a Markdown list
+
+      If you set both this and `pr-body`, the `pr-body` setting is used (it does not support templating).
+    required: false
+    default: |
+      Just testing.
   pr-body:
     description: "The body of the PR to be created"
     required: false
@@ -106,9 +137,6 @@ outputs:
   pull-request-number:
     description: "The number of the opened pull request"
     value: ${{ steps.create-pr.outputs.pull-request-number }}
-  pull-request-url:
-    description: "The The URL of the opened pull request."
-    value: ${{ steps.create-pr.outputs.pull-request-url }}
   pull-request-operation:
     description: "The pull request operation performed by the action, `created`, `updated` or `closed`."
     value: ${{ steps.create-pr.outputs.pull-request-operation }}
@@ -118,7 +146,7 @@ runs:
     - name: Import bot's GPG key for signing commits
       if: ${{ inputs.sign-commits == 'true' }}
       id: import-gpg
-      uses: crazy-max/ghaction-import-gpg@01dd5d3ca463c7f10f7f4f7b4f177225ac661ee4 # v6.1.0
+      uses: crazy-max/ghaction-import-gpg@v6
       with:
         gpg_private_key: ${{ inputs.gpg-private-key }}
         fingerprint: ${{ inputs.gpg-fingerprint }}
@@ -149,6 +177,7 @@ runs:
         echo "GIT_COMMITTER_NAME=${{ inputs.git-committer-name }}" >> $GITHUB_ENV
         echo "GIT_COMMITTER_EMAIL=<${{ inputs.git-committer-email }}>" >> $GITHUB_ENV
     - name: Run update-flake-lock
+      id: update-flake-lock
       shell: bash
       run: node "$GITHUB_ACTION_PATH/dist/index.js"
       env:
@@ -157,6 +186,7 @@ runs:
         INPUT_BASE: ${{ inputs.base }}
         INPUT_BRANCH: ${{ inputs.branch }}
         INPUT_COMMIT-MSG: ${{ inputs.commit-msg }}
+        INPUT_COMMIT-MSG-TEMPLATE: ${{ inputs.commit-msg-template }}
         INPUT_GIT-AUTHOR-EMAIL: ${{ inputs.git-author-email }}
         INPUT_GIT-AUTHOR-NAME: ${{ inputs.git-author-name }}
         INPUT_GIT-COMMITTER-EMAIL: ${{ inputs.git-committer-email }}
@@ -167,8 +197,10 @@ runs:
         INPUT_INPUTS: ${{ inputs.inputs }}
         INPUT_NIX-OPTIONS: ${{ inputs.nix-options }}
         INPUT_PATH-TO-FLAKE-DIR: ${{ inputs.path-to-flake-dir }}
+        INPUT_FLAKE-DIRS: ${{ inputs.flake-dirs }}
         INPUT_PR-ASSIGNEES: ${{ inputs.pr-assignees }}
         INPUT_PR-BODY: ${{ inputs.pr-body }}
+        INPUT_PR-BODY-TEMPLATE: ${{ inputs.pr-body-template }}
         INPUT_PR-LABELS: ${{ inputs.pr-labels }}
         INPUT_PR-REVIEWERS: ${{ inputs.pr-reviewers }}
         INPUT_PR-TITLE: ${{ inputs.pr-title }}
@@ -181,7 +213,7 @@ runs:
       uses: DamianReeves/write-file-action@v1.3
       with:
         path: pr_body.template
-        contents: ${{ inputs.pr-body }}
+        contents: ${{ steps.update-flake-lock.outputs.pr-body }}
       env: {}
     - name: Set additional env variables (GIT_COMMIT_MESSAGE)
       shell: bash
@@ -193,7 +225,7 @@ runs:
         echo "$DELIMITER" >> $GITHUB_ENV
         echo "GIT_COMMIT_MESSAGE is: ${COMMIT_MESSAGE}"
     - name: Interpolate PR Body
-      uses: pedrolamas/handlebars-action@2995d7eadacbc8f2f6ab8431a01d84a5fa3b8bb4 # v2.4.0
+      uses: pedrolamas/handlebars-action@v2.4.0
       with:
         files: "pr_body.template"
         output-filename: "pr_body.txt"
@@ -210,17 +242,16 @@ runs:
       run: rm -f pr_body.txt pr_body.template
     - name: Create PR
       id: create-pr
-      # uses: peter-evans/create-pull-request@main
-      uses: peter-evans/create-pull-request@v6.0.1
+      uses: peter-evans/create-pull-request@v6
       with:
-        base: "${{ inputs.base }}"
-        branch: "${{ inputs.branch }}"
+        base: ${{ inputs.base }}
+        branch: ${{ inputs.branch }}
         delete-branch: true
-        committer: "${{ env.GIT_COMMITTER_NAME }} ${{ env.GIT_COMMITTER_EMAIL }}"
-        author: "${{ env.GIT_AUTHOR_NAME }} ${{ env.GIT_AUTHOR_EMAIL }}"
-        title: "${{ inputs.pr-title }}"
-        token: "${{ inputs.token }}"
-        assignees: "${{ inputs.pr-assignees }}"
-        labels: "${{ inputs.pr-labels }}"
-        reviewers: "${{ inputs.pr-reviewers }}"
-        body: "${{ steps.pr_body.outputs.content }}"
+        committer: ${{ env.GIT_COMMITTER_NAME }} ${{ env.GIT_COMMITTER_EMAIL }}
+        author: ${{ env.GIT_AUTHOR_NAME }} ${{ env.GIT_AUTHOR_EMAIL }}
+        title: ${{ inputs.pr-title }}
+        token: ${{ inputs.token }}
+        assignees: ${{ inputs.pr-assignees }}
+        labels: ${{ inputs.pr-labels }}
+        reviewers: ${{ inputs.pr-reviewers }}
+        body: ${{ steps.pr_body.outputs.content }}

package.json

@@ -12,6 +12,7 @@
     "lint": "eslint src/**/*.ts --ignore-pattern *.test.ts",
     "package": "ncc build",
     "test": "vitest --watch false",
+    "test-dev": "vitest",
     "all": "pnpm run format && pnpm run lint && pnpm run build && pnpm run package"
   },
   "repository": {
@@ -26,22 +27,23 @@
   },
   "homepage": "https://github.com/DeterminateSystems/update-flake-lock#readme",
   "dependencies": {
-    "@actions/core": "^1.11.1",
+    "@actions/core": "^1.10.1",
     "@actions/exec": "^1.1.1",
-    "detsys-ts": "github:DeterminateSystems/detsys-ts"
+    "detsys-ts": "github:DeterminateSystems/detsys-ts",
+    "handlebars": "^4.7.8"
   },
   "devDependencies": {
     "@trivago/prettier-plugin-sort-imports": "^4.3.0",
-    "@typescript-eslint/eslint-plugin": "^7.18.0",
-    "@vercel/ncc": "^0.38.3",
-    "eslint": "^8.57.1",
-    "eslint-import-resolver-typescript": "^3.6.3",
+    "@typescript-eslint/eslint-plugin": "^7.11.0",
+    "@vercel/ncc": "^0.38.1",
+    "eslint": "^8.57.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-github": "^4.10.2",
-    "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-prettier": "^5.2.1",
-    "prettier": "^3.3.3",
-    "tsup": "^8.3.5",
-    "typescript": "^5.6.3",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-prettier": "^5.1.3",
+    "prettier": "^3.2.5",
+    "tsup": "^8.0.2",
+    "typescript": "^5.4.5",
     "vitest": "^1.6.0"
   }
 }

src/index.ts

@@ -1,15 +1,26 @@
 import { makeNixCommandArgs } from "./nix.js";
+import { renderCommitMessage, renderPullRequestBody } from "./template.js";
 import * as actionsCore from "@actions/core";
 import * as actionsExec from "@actions/exec";
 import { DetSysAction, inputs } from "detsys-ts";
+import * as fs from "fs";
+
+const DEFAULT_FLAKE_DIR = ".";
+
+const PR_BODY_OUTPUT_KEY = "pr-body";
 
 const EVENT_EXECUTION_FAILURE = "execution_failure";
 
 class UpdateFlakeLockAction extends DetSysAction {
   private commitMessage: string;
+  private commitMessageTemplate: string;
+  private prBody: string;
+  private prBodyTemplate: string;
   private nixOptions: string[];
   private flakeInputs: string[];
   private pathToFlakeDir: string | null;
+  private flakeDirsInput: string[] | null;
+  private flakeDirs: string[];
 
   constructor() {
     super({
@@ -19,19 +30,55 @@ class UpdateFlakeLockAction extends DetSysAction {
     });
 
     this.commitMessage = inputs.getString("commit-msg");
+    this.commitMessageTemplate = inputs.getString("commit-msg-template");
+    this.prBody = inputs.getString("pr-body");
+    this.prBodyTemplate = inputs.getString("pr-body-template");
     this.flakeInputs = inputs.getArrayOfStrings("inputs", "space");
     this.nixOptions = inputs.getArrayOfStrings("nix-options", "space");
     this.pathToFlakeDir = inputs.getStringOrNull("path-to-flake-dir");
+    this.flakeDirsInput = inputs.getArrayOfStringsOrNull("flake-dirs", "space");
+
+    this.validateInputs();
+
+    if (this.flakeDirsInput !== null && this.flakeDirsInput.length > 0) {
+      this.flakeDirs = this.flakeDirsInput;
+    } else {
+      this.flakeDirs = [this.pathToFlakeDir ?? DEFAULT_FLAKE_DIR];
+    }
   }
 
   async main(): Promise<void> {
-    await this.update();
+    for (const directory of this.flakeDirs) {
+      await this.updateFlakeInDirectory(directory);
+    }
+
+    const prBody =
+      this.prBody !== ""
+        ? this.prBody
+        : renderPullRequestBody(this.prBodyTemplate, this.flakeDirs);
+
+    actionsCore.setOutput(PR_BODY_OUTPUT_KEY, prBody);
   }
 
   // No post phase
   async post(): Promise<void> {}
 
-  async update(): Promise<void> {
+  private async updateFlakeInDirectory(flakeDir: string): Promise<void> {
+    this.ensureDirectoryExists(flakeDir);
+    this.ensureDirectoryIsFlake(flakeDir);
+
+    actionsCore.debug(`Running flake lock update in directory \`${flakeDir}\``);
+
+    const flakeDotLock = `${flakeDir}/flake.lock`;
+    const commitMessage =
+      this.commitMessage !== ""
+        ? this.commitMessage
+        : renderCommitMessage(
+            this.commitMessageTemplate,
+            flakeDir,
+            flakeDotLock,
+          );
+
     // Nix command of this form:
     // nix ${maybe nix options} flake ${"update" or "lock"} ${maybe --update-input flags} --commit-lock-file --commit-lockfile-summary ${commit message}
     // Example commands:
@@ -40,11 +87,12 @@ class UpdateFlakeLockAction extends DetSysAction {
     const nixCommandArgs: string[] = makeNixCommandArgs(
       this.nixOptions,
       this.flakeInputs,
-      this.commitMessage,
+      commitMessage,
     );
 
     actionsCore.debug(
       JSON.stringify({
+        directory: flakeDir,
         options: this.nixOptions,
         inputs: this.flakeInputs,
         message: this.commitMessage,
@@ -53,7 +101,7 @@ class UpdateFlakeLockAction extends DetSysAction {
     );
 
     const execOptions: actionsExec.ExecOptions = {
-      cwd: this.pathToFlakeDir !== null ? this.pathToFlakeDir : undefined,
+      cwd: flakeDir,
     };
 
     const exitCode = await actionsExec.exec("nix", nixCommandArgs, execOptions);
@@ -62,9 +110,69 @@ class UpdateFlakeLockAction extends DetSysAction {
       this.recordEvent(EVENT_EXECUTION_FAILURE, {
         exitCode,
       });
-      actionsCore.setFailed(`non-zero exit code of ${exitCode} detected`);
+      actionsCore.setFailed(
+        `non-zero exit code of ${exitCode} detected while updating directory \`${flakeDir}\``,
+      );
     } else {
-      actionsCore.info(`flake.lock file was successfully updated`);
+      actionsCore.info(
+        `flake.lock file in \`${flakeDir}\` was successfully updated`,
+      );
+    }
+  }
+
+  private validateInputs(): void {
+    // Ensure that either `path-to-flake-dir` or `flake-dirs` is set to a meaningful value but not both
+    if (
+      this.flakeDirsInput !== null &&
+      this.flakeDirsInput.length > 0 &&
+      this.pathToFlakeDir !== null &&
+      this.pathToFlakeDir !== ""
+    ) {
+      throw new Error(
+        "Both `path-to-flake-dir` and `flake-dirs` are set, whereas only one can be",
+      );
+    }
+
+    // Ensure that `flake-dirs` isn't an empty array if set
+    if (this.flakeDirsInput !== null && this.flakeDirsInput.length === 0) {
+      throw new Error(
+        "The `flake-dirs` input is set to an empty array; it must contain at least one directory",
+      );
+    }
+
+    // Ensure that both `flake-dirs` and `inputs` aren't set at the same time
+    if (
+      this.flakeDirsInput !== null &&
+      this.flakeDirsInput.length > 0 &&
+      this.flakeInputs.length > 0
+    ) {
+      throw new Error(
+        `You've set both \`flake-dirs\` and \`inputs\` but you can only set one`,
+      );
+    }
+  }
+
+  private ensureDirectoryExists(flakeDir: string): void {
+    actionsCore.debug(`Checking that flake directory \`${flakeDir}\` exists`);
+
+    // Ensure the directory exists
+    fs.access(flakeDir, fs.constants.F_OK, (err) => {
+      if (err !== null) {
+        throw new Error(`Directory \`${flakeDir}\` doesn't exist`);
+      } else {
+        actionsCore.debug(`Flake directory \`${flakeDir}\` exists`);
+      }
+    });
+  }
+
+  private ensureDirectoryIsFlake(flakeDir: string): void {
+    const flakeDotNix = `${flakeDir}/flake.nix`;
+    if (!fs.existsSync(flakeDotNix)) {
+      throw new Error(
+        `Directory \`${flakeDir}\` is not a valid flake as it doesn't contain a \`flake.nix\``,
+      );
+    } else {
+      actionsCore.debug(`Directory \`${flakeDir}\` is a valid flake`);
     }
   }
 }

src/nix.ts

@@ -9,23 +9,10 @@ export function makeNixCommandArgs(
     input,
   ]);
 
-  // NOTE(cole-h): In Nix versions 2.23.0 and later, `commit-lockfile-summary` became an alias to
-  // the setting `commit-lock-file-summary` (https://github.com/NixOS/nix/pull/10691), and Nix does
-  // not treat aliases the same as their "real" setting by requiring setting aliases to be
-  // configured via `--option <alias name> <option value>`
-  // (https://github.com/NixOS/nix/issues/10989).
-  // So, we go the long way so that we can support versions both before and after Nix 2.23.0.
-  const lockfileSummaryFlags = [
-    "--option",
-    "commit-lockfile-summary",
-    commitMessage,
-  ];
-
   const updateLockMechanism = flakeInputFlags.length === 0 ? "update" : "lock";
 
   return nixOptions
     .concat(["flake", updateLockMechanism])
     .concat(flakeInputFlags)
-    .concat(["--commit-lock-file"])
-    .concat(lockfileSummaryFlags);
+    .concat(["--commit-lock-file", "--commit-lockfile-summary", commitMessage]);
 }

src/template.test.ts

@@ -0,0 +1,75 @@
+import { renderCommitMessage, renderPullRequestBody } from "./template.js";
+import { template } from "handlebars";
+import { Test, describe, expect, test } from "vitest";
+
+describe("templating", () => {
+  test("commit message", () => {
+    type TestCase = {
+      template: string;
+      flakeDotLockDir: string;
+      flakeDotLock: string;
+      expected: string;
+    };
+
+    const testCases: TestCase[] = [
+      {
+        template: "Updating flake.lock in dir {{ flake_dot_lock_dir }}",
+        flakeDotLockDir: ".",
+        flakeDotLock: "./flake.lock",
+        expected: "Updating flake.lock in dir .",
+      },
+      {
+        template:
+          "Here I go doing some updating of my pristine flake.lock at {{ flake_dot_lock }}",
+        flakeDotLockDir: "subflake",
+        flakeDotLock: "subflake/flake.lock",
+        expected:
+          "Here I go doing some updating of my pristine flake.lock at subflake/flake.lock",
+      },
+      {
+        template: "This variable doesn't exist: {{ foo }}",
+        flakeDotLockDir: ".",
+        flakeDotLock: "./flake.lock",
+        expected: "This variable doesn't exist: ",
+      },
+    ];
+
+    testCases.forEach(
+      ({ template, flakeDotLockDir, flakeDotLock, expected }) => {
+        expect(
+          renderCommitMessage(template, flakeDotLockDir, flakeDotLock),
+        ).toEqual(expected);
+      },
+    );
+  });
+
+  test("pull request body", () => {
+    type TestCase = {
+      template: string;
+      dirs: string[];
+      expected: string;
+    };
+
+    const testCases: TestCase[] = [
+      {
+        template: "Updated inputs: {{ comma_separated_dirs }}",
+        dirs: ["."],
+        expected: "Updated inputs: .",
+      },
+      {
+        template: "Updated inputs: {{ space_separated_dirs }}",
+        dirs: ["subflake", "subflake2"],
+        expected: "Updated inputs: subflake subflake2",
+      },
+      {
+        template: "Updated inputs:\n{{ updated_dirs_list }}",
+        dirs: ["flake1", "flake2"],
+        expected: `Updated inputs:\n* flake1\n* flake2`,
+      },
+    ];
+
+    testCases.forEach(({ template, dirs, expected }) => {
+      expect(renderPullRequestBody(template, dirs)).toEqual(expected);
+    });
+  });
+});

src/template.ts

@@ -0,0 +1,39 @@
+import Handlebars from "handlebars";
+
+export function renderPullRequestBody(
+  template: string,
+  dirs: string[],
+): string {
+  const commaSeparated = dirs.join(", ");
+  const spaceSeparated = dirs.join(" ");
+  const dirsList = dirs.map((d: string) => `* ${d}`).join("\n");
+
+  const tpl = Handlebars.compile(template);
+
+  return tpl({
+    // eslint-disable-next-line camelcase
+    comma_separated_dirs: commaSeparated,
+    // eslint-disable-next-line camelcase
+    space_separated_dirs: spaceSeparated,
+    // eslint-disable-next-line camelcase
+    updated_dirs_list: dirsList,
+  });
+}
+
+export function renderCommitMessage(
+  template: string,
+  flakeDotLockDir: string,
+  flakeDotLock: string,
+): string {
+  return render(template, {
+    // eslint-disable-next-line camelcase
+    flake_dot_lock_dir: flakeDotLockDir,
+    // eslint-disable-next-line camelcase
+    flake_dot_lock: flakeDotLock,
+  });
+}
+
+function render(template: string, inputs: Record<string, string>): string {
+  const tpl = Handlebars.compile(template);
+  return tpl(inputs);
+}

src/update-flake-lock.test.ts

@@ -1,16 +1,16 @@
 import { makeNixCommandArgs } from "./nix.js";
 import { expect, test } from "vitest";
 
-type TestCase = {
-  inputs: {
-    nixOptions: string[];
-    flakeInputs: string[];
-    commitMessage: string;
-  };
-  expected: string[];
-};
-
 test("Nix command arguments", () => {
+  type TestCase = {
+    inputs: {
+      nixOptions: string[];
+      flakeInputs: string[];
+      commitMessage: string;
+    };
+    expected: string[];
+  };
+
   const testCases: TestCase[] = [
     {
       inputs: {
@@ -24,8 +24,7 @@ test("Nix command arguments", () => {
         "flake",
         "update",
         "--commit-lock-file",
-        "--option",
-        "commit-lockfile-summary",
+        "--commit-lockfile-summary",
         "just testing",
       ],
     },
@@ -43,8 +42,7 @@ test("Nix command arguments", () => {
         "--update-input",
         "rust-overlay",
         "--commit-lock-file",
-        "--option",
-        "commit-lockfile-summary",
+        "--commit-lockfile-summary",
         "just testing",
       ],
     },
@@ -59,8 +57,7 @@ test("Nix command arguments", () => {
         "flake",
         "update",
         "--commit-lock-file",
-        "--option",
-        "commit-lockfile-summary",
+        "--commit-lockfile-summary",
         "just testing",
       ],
     },