From be1042440b2bd532dd8ad805b30bd1ff5382a432 Mon Sep 17 00:00:00 2001 From: Vitor Mattos <1079143+vitormattos@users.noreply.github.com> Date: Wed, 18 Nov 2026 02:02:23 +0000 Subject: [PATCH 1/7] fix(ci): resolve workflow sync authentication consistently across steps Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com> --- docs/cross-repository-automation.md | 5 +- tests/test_workflow_sync_auth.py | 94 +++++++++++++++++++ .../sync-workflow-templates.yml | 9 +- 3 files changed, 103 insertions(+), 5 deletions(-) create mode 100644 tests/test_workflow_sync_auth.py diff --git a/docs/cross-repository-automation.md b/docs/cross-repository-automation.md index a2b825e..7d97f16 100644 --- a/docs/cross-repository-automation.md +++ b/docs/cross-repository-automation.md @@ -26,7 +26,10 @@ The updater manages workflows already installed in the consumer repository. It r ## Authentication -The installed updater selects authentication with the repository variable `WORKFLOW_SYNC_AUTH_MODE`: +The installed updater selects authentication with the repository variable `WORKFLOW_SYNC_AUTH_MODE`. +The shared workflow resolves the effective mode once per job (default: `librecode-app`) +and uses it consistently for validation, App creation and token selection. +Consumers can override the default in a workflow patch without changing the App steps: - `librecode-app` — LibreCode-managed repositories; uses `LIBRECODE_WORKFLOW_APP_CLIENT_ID` and `LIBRECODE_WORKFLOW_APP_PRIVATE_KEY`. - `github-app` — independent consumers; uses `WORKFLOW_SYNC_APP_CLIENT_ID` and `WORKFLOW_SYNC_APP_PRIVATE_KEY`. diff --git a/tests/test_workflow_sync_auth.py b/tests/test_workflow_sync_auth.py new file mode 100644 index 0000000..be76de3 --- /dev/null +++ b/tests/test_workflow_sync_auth.py @@ -0,0 +1,94 @@ +# SPDX-FileCopyrightText: 2026 LibreCode coop and contributors +# SPDX-License-Identifier: AGPL-3.0-or-later + +"""Regression tests for a single effective workflow authentication mode.""" + +import re +import unittest +from pathlib import Path + + +WORKFLOW = ( + Path(__file__).resolve().parents[1] + / "workflow-templates" + / "sync-workflow-templates.yml" +) + + +class WorkflowSyncAuthTest(unittest.TestCase): + @classmethod + def setUpClass(cls) -> None: + cls.content = WORKFLOW.read_text(encoding="utf-8") + + def test_job_scope_defines_the_mode_once(self) -> None: + job = self.content.split(" dispatch:\n", 1)[1] + resolved = re.findall( + r"^ AUTH_MODE: .* [|][|] '([^']+)' }}$", + job, re.MULTILINE, + ) + self.assertEqual(resolved, ["librecode-app"]) + self.assertIn( + " env:\n AUTH_MODE: ", job + ) + self.assertEqual(len(re.findall( + r"^\s*AUTH_MODE:", job, re.MULTILINE + )), 1) + + def test_app_gates_use_the_resolved_job_mode(self) -> None: + for name, expected in ( + ("Create LibreCode GitHub App token", "librecode-app"), + ("Create consumer GitHub App token", "github-app"), + ): + with self.subTest(step=name): + step = self.content.split(" - name: " + name + "\n", 1)[1] + step = step.split(" - name: ", 1)[0] + gate = re.findall( + r"^\s*if: .*env\.AUTH_MODE == '([^']+)' }}$", + step, re.MULTILINE, + ) + self.assertEqual(gate, [expected]) + + def test_validation_and_token_selection_consume_inherited_mode(self) -> None: + for name in ( + "Validate workflow sync authentication", + "Resolve workflow sync token", + ): + with self.subTest(step=name): + step = self.content.split(" - name: " + name + "\n", 1)[1] + step = step.split(" - name: ", 1)[0] + self.assertIn('case "' + '$' + '{AUTH_MODE}" in', step) + self.assertNotRegex(step, r"^\s*AUTH_MODE:", re.MULTILINE) + + def test_unset_token_and_app_modes(self) -> None: + resolved_default = re.search( + r"^ AUTH_MODE: .* [|][|] '([^']+)' }}$", + self.content, re.MULTILINE, + ).group(1) + gates = {"librecode-app": [], "github-app": []} + for name, role in ( + ("Create LibreCode GitHub App token", "librecode-app"), + ("Create consumer GitHub App token", "github-app"), + ): + step = self.content.split(" - name: " + name + "\n", 1)[1] + gates[role] = re.search( + r"^\s*if: .*env\.AUTH_MODE == '([^']+)' }}$", + step, re.MULTILINE, + ).group(1) + + expected = { + "": (True, False), + "token": (False, False), + "librecode-app": (True, False), + "github-app": (False, True), + "github-token": (False, False), + } + for configured, should_run in expected.items(): + with self.subTest(configured=configured or "(unset)"): + effective = configured or resolved_default + actual = (effective == gates["librecode-app"], + effective == gates["github-app"]) + self.assertEqual(actual, should_run) + + +if __name__ == "__main__": + unittest.main() diff --git a/workflow-templates/sync-workflow-templates.yml b/workflow-templates/sync-workflow-templates.yml index abdcfe6..877c09e 100644 --- a/workflow-templates/sync-workflow-templates.yml +++ b/workflow-templates/sync-workflow-templates.yml @@ -36,6 +36,9 @@ jobs: contents: write pull-requests: write + env: + AUTH_MODE: ${{ vars.WORKFLOW_SYNC_AUTH_MODE || 'librecode-app' }} + steps: - name: Check actor permission if: ${{ github.event_name == 'workflow_dispatch' }} @@ -53,7 +56,6 @@ jobs: - name: Validate workflow sync authentication shell: bash env: - AUTH_MODE: ${{ vars.WORKFLOW_SYNC_AUTH_MODE || 'librecode-app' }} LIBRECODE_APP_CLIENT_ID: ${{ vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID }} LIBRECODE_APP_PRIVATE_KEY: ${{ secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY }} CONSUMER_APP_CLIENT_ID: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID }} @@ -90,7 +92,7 @@ jobs: esac - name: Create LibreCode GitHub App token - if: ${{ vars.WORKFLOW_SYNC_AUTH_MODE == '' || vars.WORKFLOW_SYNC_AUTH_MODE == 'librecode-app' }} + if: ${{ env.AUTH_MODE == 'librecode-app' }} id: librecode-app-token uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510 # v3.3.0 with: @@ -103,7 +105,7 @@ jobs: permission-workflows: write - name: Create consumer GitHub App token - if: ${{ vars.WORKFLOW_SYNC_AUTH_MODE == 'github-app' }} + if: ${{ env.AUTH_MODE == 'github-app' }} id: consumer-app-token uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510 # v3.3.0 with: @@ -119,7 +121,6 @@ jobs: id: auth-token shell: bash env: - AUTH_MODE: ${{ vars.WORKFLOW_SYNC_AUTH_MODE || 'librecode-app' }} LIBRECODE_APP_TOKEN: ${{ steps.librecode-app-token.outputs.token }} CONSUMER_APP_TOKEN: ${{ steps.consumer-app-token.outputs.token }} CONSUMER_TOKEN: ${{ secrets.WORKFLOW_SYNC_TOKEN }} From 3050a293545fd4873cc28b60962c65f262df0ec2 Mon Sep 17 00:00:00 2001 From: Vitor Mattos <1079143+vitormattos@users.noreply.github.com> Date: Wed, 18 Nov 2026 02:04:44 +0000 Subject: [PATCH 2/7] fix(ci): update upstream patch for normalized workflow auth Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com> --- patches/nextcloud/sync-workflow-templates.yml.patch | 13 +++++++------ tests/test_workflow_sync_auth.py | 2 +- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/patches/nextcloud/sync-workflow-templates.yml.patch b/patches/nextcloud/sync-workflow-templates.yml.patch index 8081e2b..00ea23e 100644 --- a/patches/nextcloud/sync-workflow-templates.yml.patch +++ b/patches/nextcloud/sync-workflow-templates.yml.patch @@ -35,8 +35,11 @@ name: Update workflows in ${{ matrix.branches }} -@@ -38,16 +38,123 @@ +@@ -38,16 +38,124 @@ ++ env: ++ AUTH_MODE: ${{ vars.WORKFLOW_SYNC_AUTH_MODE || 'librecode-app' }} ++ steps: - name: Check actor permission + if: ${{ github.event_name == 'workflow_dispatch' }} @@ -54,7 +57,6 @@ + - name: Validate workflow sync authentication + shell: bash + env: -+ AUTH_MODE: ${{ vars.WORKFLOW_SYNC_AUTH_MODE || 'librecode-app' }} + LIBRECODE_APP_CLIENT_ID: ${{ vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID }} + LIBRECODE_APP_PRIVATE_KEY: ${{ secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY }} + CONSUMER_APP_CLIENT_ID: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID }} @@ -91,7 +93,7 @@ + esac + + - name: Create LibreCode GitHub App token -+ if: ${{ vars.WORKFLOW_SYNC_AUTH_MODE == '' || vars.WORKFLOW_SYNC_AUTH_MODE == 'librecode-app' }} ++ if: ${{ env.AUTH_MODE == 'librecode-app' }} + id: librecode-app-token + uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0 + with: @@ -104,7 +106,7 @@ + permission-workflows: write + + - name: Create consumer GitHub App token -+ if: ${{ vars.WORKFLOW_SYNC_AUTH_MODE == 'github-app' }} ++ if: ${{ env.AUTH_MODE == 'github-app' }} + id: consumer-app-token + uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0 - uses: skjnldsv/check-actor-permission@69e92a3c4711150929bca9fcf34448c5bf5526e7 # v3.0 @@ -121,7 +123,6 @@ + id: auth-token + shell: bash + env: -+ AUTH_MODE: ${{ vars.WORKFLOW_SYNC_AUTH_MODE || 'librecode-app' }} + LIBRECODE_APP_TOKEN: ${{ steps.librecode-app-token.outputs.token }} + CONSUMER_APP_TOKEN: ${{ steps.consumer-app-token.outputs.token }} + CONSUMER_TOKEN: ${{ secrets.WORKFLOW_SYNC_TOKEN }} @@ -162,7 +163,7 @@ - name: Checkout app uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 -@@ -56,112 +163,31 @@ +@@ -56,112 +164,31 @@ path: target ref: ${{ matrix.branches }} diff --git a/tests/test_workflow_sync_auth.py b/tests/test_workflow_sync_auth.py index be76de3..834a302 100644 --- a/tests/test_workflow_sync_auth.py +++ b/tests/test_workflow_sync_auth.py @@ -57,7 +57,7 @@ def test_validation_and_token_selection_consume_inherited_mode(self) -> None: step = self.content.split(" - name: " + name + "\n", 1)[1] step = step.split(" - name: ", 1)[0] self.assertIn('case "' + '$' + '{AUTH_MODE}" in', step) - self.assertNotRegex(step, r"^\s*AUTH_MODE:", re.MULTILINE) + self.assertIsNone(re.search(r"^\s*AUTH_MODE:", step, re.MULTILINE)) def test_unset_token_and_app_modes(self) -> None: resolved_default = re.search( From 258c35e199161c1d5cf35a39a7743a52091262b1 Mon Sep 17 00:00:00 2001 From: Vitor Mattos <1079143+vitormattos@users.noreply.github.com> Date: Wed, 18 Nov 2026 02:21:23 +0000 Subject: [PATCH 3/7] refactor(ci): make GitHub App authentication provider-neutral with legacy fallback Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com> --- docs/cross-repository-automation.md | 42 +++-- .../sync-workflow-templates.yml.patch | 121 +++++++------- tests/test_workflow_sync_auth.py | 151 ++++++++++-------- .../sync-workflow-templates.yml | 86 +++++----- 4 files changed, 207 insertions(+), 193 deletions(-) diff --git a/docs/cross-repository-automation.md b/docs/cross-repository-automation.md index 7d97f16..0f52780 100644 --- a/docs/cross-repository-automation.md +++ b/docs/cross-repository-automation.md @@ -26,19 +26,35 @@ The updater manages workflows already installed in the consumer repository. It r ## Authentication -The installed updater selects authentication with the repository variable `WORKFLOW_SYNC_AUTH_MODE`. -The shared workflow resolves the effective mode once per job (default: `librecode-app`) -and uses it consistently for validation, App creation and token selection. -Consumers can override the default in a workflow patch without changing the App steps: - -- `librecode-app` — LibreCode-managed repositories; uses `LIBRECODE_WORKFLOW_APP_CLIENT_ID` and `LIBRECODE_WORKFLOW_APP_PRIVATE_KEY`. -- `github-app` — independent consumers; uses `WORKFLOW_SYNC_APP_CLIENT_ID` and `WORKFLOW_SYNC_APP_PRIVATE_KEY`. -- `token` — uses `WORKFLOW_SYNC_TOKEN`. -- `github-token` — uses the workflow `GITHUB_TOKEN`. - -For independent projects, prefer a consumer-owned GitHub App. The updater needs repository permissions **Contents: write**, **Pull requests: write**, and **Workflows: write** because it updates files under `.github/workflows`. - -The `github-token` mode is explicit because events created with `GITHUB_TOKEN` may not trigger the repository's normal pull-request automation. +The workflow has a provider-neutral interface. Set the repository variable +`WORKFLOW_SYNC_AUTH_MODE` to choose a credential source: + +- `github-app` (default) — preferred. Configure variable + `WORKFLOW_SYNC_APP_CLIENT_ID` and secret `WORKFLOW_SYNC_APP_PRIVATE_KEY`. +- `token` — configure secret `WORKFLOW_SYNC_TOKEN`. +- `github-token` — use the workflow's built-in `GITHUB_TOKEN`. + +A consumer-owned GitHub App is recommended. It needs repository permissions +**Contents: write**, **Pull requests: write** and **Workflows: write** +to update files under `.github/workflows`. + +### Compatibility with existing consumers + +The former `librecode-app` mode is still accepted as an alias for `github-app`. +If the generic App credentials are absent, the workflow also accepts the +previous `LIBRECODE_WORKFLOW_APP_CLIENT_ID` variable and +`LIBRECODE_WORKFLOW_APP_PRIVATE_KEY` secret. This is a compatibility fallback, +not a requirement for new consumers. Both generic credentials must be configured +together; a partially configured generic pair fails validation rather than +mixing credentials from different Apps. + +To migrate an existing consumer, configure the generic variable and secret as +a pair, change any explicit `librecode-app` mode to `github-app`, verify one +sync run, and only then retire the previous values. The organization hosting +the catalog is independent of the App used by the consumer. + +`github-token` remains an explicit choice because events created with +`GITHUB_TOKEN` may not trigger normal pull-request automation. ## Install and update workflows diff --git a/patches/nextcloud/sync-workflow-templates.yml.patch b/patches/nextcloud/sync-workflow-templates.yml.patch index 00ea23e..61b3169 100644 --- a/patches/nextcloud/sync-workflow-templates.yml.patch +++ b/patches/nextcloud/sync-workflow-templates.yml.patch @@ -1,6 +1,6 @@ --- upstream/vendor/nextcloud/sync-workflow-templates.yml +++ workflow-templates/sync-workflow-templates.yml -@@ -1,13 +1,16 @@ +@@ -1,18 +1,21 @@ # This workflow is provided via the organization template repository # +# https://github.com/LibreCodeCoop/.github @@ -20,11 +20,12 @@ name: Update workflows on: workflow_dispatch: -@@ -14,3 +17,3 @@ schedule: -- - cron: "45 22 * * 6" + - cron: "5 2 * * 0" +- - cron: "45 22 * * 6" + permissions: + contents: read @@ -26,9 +29,6 @@ matrix: branches: @@ -35,10 +36,12 @@ name: Update workflows in ${{ matrix.branches }} -@@ -38,16 +38,124 @@ +@@ -36,18 +36,112 @@ + contents: write + pull-requests: write + env: -+ AUTH_MODE: ${{ vars.WORKFLOW_SYNC_AUTH_MODE || 'librecode-app' }} ++ AUTH_MODE: ${{ vars.WORKFLOW_SYNC_AUTH_MODE || 'github-app' }} + steps: - name: Check actor permission @@ -57,29 +60,30 @@ + - name: Validate workflow sync authentication + shell: bash + env: -+ LIBRECODE_APP_CLIENT_ID: ${{ vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID }} -+ LIBRECODE_APP_PRIVATE_KEY: ${{ secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY }} -+ CONSUMER_APP_CLIENT_ID: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID }} -+ CONSUMER_APP_PRIVATE_KEY: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY }} -+ CONSUMER_TOKEN: ${{ secrets.WORKFLOW_SYNC_TOKEN }} ++ APP_CLIENT_ID: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID } ++ APP_PRIVATE_KEY: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY } ++ LEGACY_APP_CLIENT_ID: ${{ vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID } ++ LEGACY_APP_PRIVATE_KEY: ${{ secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY } ++ CONSUMER_TOKEN: ${{ secrets.WORKFLOW_SYNC_TOKEN } + run: | + set -euo pipefail + -+ case "${AUTH_MODE}" in -+ librecode-app) -+ [[ -n "${LIBRECODE_APP_CLIENT_ID}" && -n "${LIBRECODE_APP_PRIVATE_KEY}" ]] || { -+ echo "::error::librecode-app requires LIBRECODE_WORKFLOW_APP_CLIENT_ID and LIBRECODE_WORKFLOW_APP_PRIVATE_KEY" -+ exit 1 -+ } -+ ;; -+ github-app) -+ [[ -n "${CONSUMER_APP_CLIENT_ID}" && -n "${CONSUMER_APP_PRIVATE_KEY}" ]] || { ++ case "\${AUTH_MODE}" in ++ github-app|librecode-app) ++ if [[ -n "\${APP_CLIENT_ID}" || -n "\${APP_PRIVATE_KEY}" ]]; then ++ [[ -n "\${APP_CLIENT_ID}" && -n "\${APP_PRIVATE_KEY}" ]] || { ++ echo "::error::WORKFLOW_SYNC_APP_CLIENT_ID and WORKFLOW_SYNC_APP_PRIVATE_KEY must be configured together" ++ exit 1 ++ } ++ elif [[ -n "\${LEGACY_APP_CLIENT_ID}" && -n "\${LEGACY_APP_PRIVATE_KEY}" ]]; then ++ echo "::notice::Legacy App credentials are supported for compatibility; migrate to WORKFLOW_SYNC_APP_*" ++ else + echo "::error::github-app requires WORKFLOW_SYNC_APP_CLIENT_ID and WORKFLOW_SYNC_APP_PRIVATE_KEY" + exit 1 -+ } ++ fi + ;; + token) -+ [[ -n "${CONSUMER_TOKEN}" ]] || { ++ [[ -n "\${CONSUMER_TOKEN}" ]] || { + echo "::error::token mode requires WORKFLOW_SYNC_TOKEN" + exit 1 + } @@ -87,34 +91,21 @@ + github-token) + ;; + *) -+ echo "::error::Unsupported WORKFLOW_SYNC_AUTH_MODE: ${AUTH_MODE}" ++ echo "::error::Unsupported WORKFLOW_SYNC_AUTH_MODE: \${AUTH_MODE}" + exit 1 + ;; + esac + -+ - name: Create LibreCode GitHub App token -+ if: ${{ env.AUTH_MODE == 'librecode-app' }} -+ id: librecode-app-token -+ uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0 -+ with: -+ client-id: ${{ vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID }} -+ private-key: ${{ secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY }} -+ owner: ${{ github.repository_owner }} -+ repositories: ${{ github.event.repository.name }} -+ permission-contents: write -+ permission-pull-requests: write -+ permission-workflows: write -+ -+ - name: Create consumer GitHub App token -+ if: ${{ env.AUTH_MODE == 'github-app' }} -+ id: consumer-app-token -+ uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0 ++ - name: Create GitHub App token ++ if: ${{ env.AUTH_MODE == 'github-app' || env.AUTH_MODE == 'librecode-app' } ++ id: workflow-app-token ++ uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510 # v3.3.0 - uses: skjnldsv/check-actor-permission@69e92a3c4711150929bca9fcf34448c5bf5526e7 # v3.0 with: -+ client-id: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID }} -+ private-key: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY }} -+ owner: ${{ github.repository_owner }} -+ repositories: ${{ github.event.repository.name }} ++ client-id: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID || vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID } ++ private-key: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY || secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY } ++ owner: ${{ github.repository_owner } ++ repositories: ${{ github.event.repository.name } + permission-contents: write + permission-pull-requests: write + permission-workflows: write @@ -123,28 +114,26 @@ + id: auth-token + shell: bash + env: -+ LIBRECODE_APP_TOKEN: ${{ steps.librecode-app-token.outputs.token }} -+ CONSUMER_APP_TOKEN: ${{ steps.consumer-app-token.outputs.token }} -+ CONSUMER_TOKEN: ${{ secrets.WORKFLOW_SYNC_TOKEN }} -+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} ++ WORKFLOW_APP_TOKEN: ${{ steps.workflow-app-token.outputs.token } ++ CONSUMER_TOKEN: ${{ secrets.WORKFLOW_SYNC_TOKEN } ++ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN } + run: | + set -euo pipefail + -+ case "${AUTH_MODE}" in -+ librecode-app) token="${LIBRECODE_APP_TOKEN}" ;; -+ github-app) token="${CONSUMER_APP_TOKEN}" ;; -+ token) token="${CONSUMER_TOKEN}" ;; -+ github-token) token="${GITHUB_TOKEN}" ;; ++ case "\${AUTH_MODE}" in ++ github-app|librecode-app) token="\${WORKFLOW_APP_TOKEN}" ;; ++ token) token="\${CONSUMER_TOKEN}" ;; ++ github-token) token="\${GITHUB_TOKEN}" ;; + *) exit 1 ;; + esac + -+ [[ -n "${token}" ]] || { ++ [[ -n "\${token}" ]] || { + echo "::error::Selected workflow sync authentication produced an empty token" + exit 1 + } + -+ echo "::add-mask::${token}" -+ echo "token=${token}" >> "${GITHUB_OUTPUT}" ++ echo "::add-mask::\${token}" ++ echo "token=\${token}" >> "\${GITHUB_OUTPUT}" - require: admin - name: Checkout workflow repository @@ -163,10 +152,17 @@ - name: Checkout app uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 -@@ -56,112 +164,31 @@ +@@ -56,112 +150,31 @@ path: target ref: ${{ matrix.branches }} ++ - name: Synchronize workflow templates ++ id: sync ++ uses: ./source/actions/sync-workflows ++ with: ++ source: source/workflow-templates ++ target: target ++ catalog-commit: ${{ steps.catalog-revision.outputs.sha }} - - name: Check for active merge freeze - id: freeze - env: @@ -190,14 +186,7 @@ - echo 'active=true' >> $GITHUB_OUTPUT - fi - rm version.php -- -+ - name: Synchronize workflow templates -+ id: sync -+ uses: ./source/actions/sync-workflows -+ with: -+ source: source/workflow-templates -+ target: target -+ catalog-commit: ${{ steps.catalog-revision.outputs.sha }} + - - name: Copy all workflow templates - if: steps.freeze.outputs.active != 'true' - run: | @@ -208,7 +197,7 @@ - if [ -f "$workflow" ]; then - filename=$(basename "$workflow") - target_file="./target/.github/workflows/$filename" - +- - # Only copy if the file exists in the target repository - if [ -f "$target_file" ]; then - if [ -f "./target/.github/actions-lock.txt" ]; then @@ -264,8 +253,8 @@ - echo "DRAFT_ONLY=${draft_only}" >> $GITHUB_ENV - - name: Create Pull Request -- if: steps.freeze.outputs.active != 'true' + if: ${{ steps.sync.outputs.changed == 'true' }} +- if: steps.freeze.outputs.active != 'true' uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v8.1.1 with: + token: ${{ steps.auth-token.outputs.token }} diff --git a/tests/test_workflow_sync_auth.py b/tests/test_workflow_sync_auth.py index 834a302..89098c6 100644 --- a/tests/test_workflow_sync_auth.py +++ b/tests/test_workflow_sync_auth.py @@ -1,13 +1,14 @@ # SPDX-FileCopyrightText: 2026 LibreCode coop and contributors # SPDX-License-Identifier: AGPL-3.0-or-later -"""Regression tests for a single effective workflow authentication mode.""" +"""Regression tests for provider-neutral workflow authentication.""" +import os import re +import subprocess import unittest from pathlib import Path - WORKFLOW = ( Path(__file__).resolve().parents[1] / "workflow-templates" @@ -20,74 +21,96 @@ class WorkflowSyncAuthTest(unittest.TestCase): def setUpClass(cls) -> None: cls.content = WORKFLOW.read_text(encoding="utf-8") - def test_job_scope_defines_the_mode_once(self) -> None: - job = self.content.split(" dispatch:\n", 1)[1] - resolved = re.findall( - r"^ AUTH_MODE: .* [|][|] '([^']+)' }}$", - job, re.MULTILINE, + def step(self, name: str) -> str: + text = self.content.split(" - name: " + name + "\n", 1)[1] + return text.split(" - name: ", 1)[0] + + def validation_script(self) -> str: + step = self.step("Validate workflow sync authentication") + script = step.split(" run: |\n", 1)[1] + return "\n".join( + line[10:] if line.startswith(" ") else line + for line in script.splitlines() + ) + "\n" + + def test_public_default_and_one_app_step(self) -> None: + self.assertIn( + "AUTH_MODE: " + "$" + "{{ vars.WORKFLOW_SYNC_AUTH_MODE || 'github-app' }}", + self.content, ) - self.assertEqual(resolved, ["librecode-app"]) + self.assertEqual( + self.content.count(" - name: Create GitHub App token\n"), 1 + ) + self.assertNotIn(" - name: Create LibreCode GitHub App token\n", + self.content) + self.assertNotIn(" - name: Create consumer GitHub App token\n", + self.content) + self.assertEqual( + len(re.findall(r"^\s*AUTH_MODE:", self.content, re.MULTILINE)), 1 + ) + + def test_app_gate_and_credential_precedence(self) -> None: + step = self.step("Create GitHub App token") self.assertIn( - " env:\n AUTH_MODE: ", job + "env.AUTH_MODE == 'github-app' || env.AUTH_MODE == 'librecode-app'", + step, ) - self.assertEqual(len(re.findall( - r"^\s*AUTH_MODE:", job, re.MULTILINE - )), 1) + self.assertIn( + "vars.WORKFLOW_SYNC_APP_CLIENT_ID || " + "vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID", step, + ) + self.assertIn( + "secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY || " + "secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY", step, + ) + self.assertEqual(self.content.count("id: workflow-app-token"), 1) + self.assertIn("steps.workflow-app-token.outputs.token", + self.step("Resolve workflow sync token")) - def test_app_gates_use_the_resolved_job_mode(self) -> None: - for name, expected in ( - ("Create LibreCode GitHub App token", "librecode-app"), - ("Create consumer GitHub App token", "github-app"), - ): - with self.subTest(step=name): - step = self.content.split(" - name: " + name + "\n", 1)[1] - step = step.split(" - name: ", 1)[0] - gate = re.findall( - r"^\s*if: .*env\.AUTH_MODE == '([^']+)' }}$", - step, re.MULTILINE, + def test_validate_modes_and_credential_pairs(self) -> None: + script = self.validation_script() + fixtures = ( + # name, mode, generic ID/key, legacy ID/key, token, success + ("generic default", "github-app", "id", "key", "", "", "", True), + ("legacy fallback", "github-app", "", "", "old-id", "old-key", "", True), + ("legacy mode", "librecode-app", "", "", "old-id", "old-key", "", True), + ("generic preferred", "github-app", "id", "key", "old-id", + "old-key", "", True), + ("partial generic ID", "github-app", "id", "", "old-id", + "old-key", "", False), + ("partial generic key", "github-app", "", "key", "old-id", + "old-key", "", False), + ("missing app credentials", "github-app", "", "", "", "", "", False), + ("partial legacy ID", "github-app", "", "", "old-id", "", "", False), + ("partial legacy key", "github-app", "", "", "", "old-key", "", False), + ("token", "token", "", "", "", "", "token-value", True), + ("missing token", "token", "", "", "", "", "", False), + ("github-token", "github-token", "", "", "", "", "", True), + ("unsupported", "unrecognized", "", "", "", "", "", False), + ) + for name, mode, gid, gkey, lid, lkey, token, expected in fixtures: + with self.subTest(case=name): + env = dict(os.environ, AUTH_MODE=mode, + APP_CLIENT_ID=gid, APP_PRIVATE_KEY=gkey, + LEGACY_APP_CLIENT_ID=lid, + LEGACY_APP_PRIVATE_KEY=lkey, + CONSUMER_TOKEN=token) + result = subprocess.run( + ["bash", "-e", "-c", script], env=env, text=True, + capture_output=True, check=False, + ) + self.assertEqual( + result.returncode == 0, expected, + name + ": " + result.stderr + result.stdout, ) - self.assertEqual(gate, [expected]) - - def test_validation_and_token_selection_consume_inherited_mode(self) -> None: - for name in ( - "Validate workflow sync authentication", - "Resolve workflow sync token", - ): - with self.subTest(step=name): - step = self.content.split(" - name: " + name + "\n", 1)[1] - step = step.split(" - name: ", 1)[0] - self.assertIn('case "' + '$' + '{AUTH_MODE}" in', step) - self.assertIsNone(re.search(r"^\s*AUTH_MODE:", step, re.MULTILINE)) - - def test_unset_token_and_app_modes(self) -> None: - resolved_default = re.search( - r"^ AUTH_MODE: .* [|][|] '([^']+)' }}$", - self.content, re.MULTILINE, - ).group(1) - gates = {"librecode-app": [], "github-app": []} - for name, role in ( - ("Create LibreCode GitHub App token", "librecode-app"), - ("Create consumer GitHub App token", "github-app"), - ): - step = self.content.split(" - name: " + name + "\n", 1)[1] - gates[role] = re.search( - r"^\s*if: .*env\.AUTH_MODE == '([^']+)' }}$", - step, re.MULTILINE, - ).group(1) - expected = { - "": (True, False), - "token": (False, False), - "librecode-app": (True, False), - "github-app": (False, True), - "github-token": (False, False), - } - for configured, should_run in expected.items(): - with self.subTest(configured=configured or "(unset)"): - effective = configured or resolved_default - actual = (effective == gates["librecode-app"], - effective == gates["github-app"]) - self.assertEqual(actual, should_run) + def test_token_selection_is_shared(self) -> None: + step = self.step("Resolve workflow sync token") + self.assertIn("github-app|librecode-app)", step) + self.assertIn('token="' + '$' + '{WORKFLOW_APP_TOKEN}"', step) + self.assertIn('token="' + '$' + '{CONSUMER_TOKEN}"', step) + self.assertIn('token="' + '$' + '{GITHUB_TOKEN}"', step) + self.assertNotIn("LIBRECODE_APP_TOKEN", step) if __name__ == "__main__": diff --git a/workflow-templates/sync-workflow-templates.yml b/workflow-templates/sync-workflow-templates.yml index 877c09e..39ac8ce 100644 --- a/workflow-templates/sync-workflow-templates.yml +++ b/workflow-templates/sync-workflow-templates.yml @@ -37,7 +37,7 @@ jobs: pull-requests: write env: - AUTH_MODE: ${{ vars.WORKFLOW_SYNC_AUTH_MODE || 'librecode-app' }} + AUTH_MODE: ${{ vars.WORKFLOW_SYNC_AUTH_MODE || 'github-app' }} steps: - name: Check actor permission @@ -56,29 +56,30 @@ jobs: - name: Validate workflow sync authentication shell: bash env: - LIBRECODE_APP_CLIENT_ID: ${{ vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID }} - LIBRECODE_APP_PRIVATE_KEY: ${{ secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY }} - CONSUMER_APP_CLIENT_ID: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID }} - CONSUMER_APP_PRIVATE_KEY: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY }} - CONSUMER_TOKEN: ${{ secrets.WORKFLOW_SYNC_TOKEN }} + APP_CLIENT_ID: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID } + APP_PRIVATE_KEY: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY } + LEGACY_APP_CLIENT_ID: ${{ vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID } + LEGACY_APP_PRIVATE_KEY: ${{ secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY } + CONSUMER_TOKEN: ${{ secrets.WORKFLOW_SYNC_TOKEN } run: | set -euo pipefail - case "${AUTH_MODE}" in - librecode-app) - [[ -n "${LIBRECODE_APP_CLIENT_ID}" && -n "${LIBRECODE_APP_PRIVATE_KEY}" ]] || { - echo "::error::librecode-app requires LIBRECODE_WORKFLOW_APP_CLIENT_ID and LIBRECODE_WORKFLOW_APP_PRIVATE_KEY" - exit 1 - } - ;; - github-app) - [[ -n "${CONSUMER_APP_CLIENT_ID}" && -n "${CONSUMER_APP_PRIVATE_KEY}" ]] || { + case "\${AUTH_MODE}" in + github-app|librecode-app) + if [[ -n "\${APP_CLIENT_ID}" || -n "\${APP_PRIVATE_KEY}" ]]; then + [[ -n "\${APP_CLIENT_ID}" && -n "\${APP_PRIVATE_KEY}" ]] || { + echo "::error::WORKFLOW_SYNC_APP_CLIENT_ID and WORKFLOW_SYNC_APP_PRIVATE_KEY must be configured together" + exit 1 + } + elif [[ -n "\${LEGACY_APP_CLIENT_ID}" && -n "\${LEGACY_APP_PRIVATE_KEY}" ]]; then + echo "::notice::Legacy App credentials are supported for compatibility; migrate to WORKFLOW_SYNC_APP_*" + else echo "::error::github-app requires WORKFLOW_SYNC_APP_CLIENT_ID and WORKFLOW_SYNC_APP_PRIVATE_KEY" exit 1 - } + fi ;; token) - [[ -n "${CONSUMER_TOKEN}" ]] || { + [[ -n "\${CONSUMER_TOKEN}" ]] || { echo "::error::token mode requires WORKFLOW_SYNC_TOKEN" exit 1 } @@ -86,33 +87,20 @@ jobs: github-token) ;; *) - echo "::error::Unsupported WORKFLOW_SYNC_AUTH_MODE: ${AUTH_MODE}" + echo "::error::Unsupported WORKFLOW_SYNC_AUTH_MODE: \${AUTH_MODE}" exit 1 ;; esac - - name: Create LibreCode GitHub App token - if: ${{ env.AUTH_MODE == 'librecode-app' }} - id: librecode-app-token - uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510 # v3.3.0 - with: - client-id: ${{ vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID }} - private-key: ${{ secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY }} - owner: ${{ github.repository_owner }} - repositories: ${{ github.event.repository.name }} - permission-contents: write - permission-pull-requests: write - permission-workflows: write - - - name: Create consumer GitHub App token - if: ${{ env.AUTH_MODE == 'github-app' }} - id: consumer-app-token + - name: Create GitHub App token + if: ${{ env.AUTH_MODE == 'github-app' || env.AUTH_MODE == 'librecode-app' } + id: workflow-app-token uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510 # v3.3.0 with: - client-id: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID }} - private-key: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY }} - owner: ${{ github.repository_owner }} - repositories: ${{ github.event.repository.name }} + client-id: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID || vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID } + private-key: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY || secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY } + owner: ${{ github.repository_owner } + repositories: ${{ github.event.repository.name } permission-contents: write permission-pull-requests: write permission-workflows: write @@ -121,28 +109,26 @@ jobs: id: auth-token shell: bash env: - LIBRECODE_APP_TOKEN: ${{ steps.librecode-app-token.outputs.token }} - CONSUMER_APP_TOKEN: ${{ steps.consumer-app-token.outputs.token }} - CONSUMER_TOKEN: ${{ secrets.WORKFLOW_SYNC_TOKEN }} - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + WORKFLOW_APP_TOKEN: ${{ steps.workflow-app-token.outputs.token } + CONSUMER_TOKEN: ${{ secrets.WORKFLOW_SYNC_TOKEN } + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN } run: | set -euo pipefail - case "${AUTH_MODE}" in - librecode-app) token="${LIBRECODE_APP_TOKEN}" ;; - github-app) token="${CONSUMER_APP_TOKEN}" ;; - token) token="${CONSUMER_TOKEN}" ;; - github-token) token="${GITHUB_TOKEN}" ;; + case "\${AUTH_MODE}" in + github-app|librecode-app) token="\${WORKFLOW_APP_TOKEN}" ;; + token) token="\${CONSUMER_TOKEN}" ;; + github-token) token="\${GITHUB_TOKEN}" ;; *) exit 1 ;; esac - [[ -n "${token}" ]] || { + [[ -n "\${token}" ]] || { echo "::error::Selected workflow sync authentication produced an empty token" exit 1 } - echo "::add-mask::${token}" - echo "token=${token}" >> "${GITHUB_OUTPUT}" + echo "::add-mask::\${token}" + echo "token=\${token}" >> "\${GITHUB_OUTPUT}" - name: Checkout workflow repository uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 From d0ebb344631b26c28fd93f7c8430492448f284a8 Mon Sep 17 00:00:00 2001 From: Vitor Mattos <1079143+vitormattos@users.noreply.github.com> Date: Wed, 18 Nov 2026 02:22:18 +0000 Subject: [PATCH 4/7] fix(ci): correct GitHub expressions and Bash expansion in generic auth template Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com> --- .../sync-workflow-templates.yml.patch | 52 +++++++++---------- tests/test_workflow_sync_auth.py | 5 ++ .../sync-workflow-templates.yml | 52 +++++++++---------- 3 files changed, 57 insertions(+), 52 deletions(-) diff --git a/patches/nextcloud/sync-workflow-templates.yml.patch b/patches/nextcloud/sync-workflow-templates.yml.patch index 61b3169..4dcdf50 100644 --- a/patches/nextcloud/sync-workflow-templates.yml.patch +++ b/patches/nextcloud/sync-workflow-templates.yml.patch @@ -60,22 +60,22 @@ + - name: Validate workflow sync authentication + shell: bash + env: -+ APP_CLIENT_ID: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID } -+ APP_PRIVATE_KEY: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY } -+ LEGACY_APP_CLIENT_ID: ${{ vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID } -+ LEGACY_APP_PRIVATE_KEY: ${{ secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY } -+ CONSUMER_TOKEN: ${{ secrets.WORKFLOW_SYNC_TOKEN } ++ APP_CLIENT_ID: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID }} ++ APP_PRIVATE_KEY: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY }} ++ LEGACY_APP_CLIENT_ID: ${{ vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID }} ++ LEGACY_APP_PRIVATE_KEY: ${{ secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY }} ++ CONSUMER_TOKEN: ${{ secrets.WORKFLOW_SYNC_TOKEN }} + run: | + set -euo pipefail + -+ case "\${AUTH_MODE}" in ++ case "${AUTH_MODE}" in + github-app|librecode-app) -+ if [[ -n "\${APP_CLIENT_ID}" || -n "\${APP_PRIVATE_KEY}" ]]; then -+ [[ -n "\${APP_CLIENT_ID}" && -n "\${APP_PRIVATE_KEY}" ]] || { ++ if [[ -n "${APP_CLIENT_ID}" || -n "${APP_PRIVATE_KEY}" ]]; then ++ [[ -n "${APP_CLIENT_ID}" && -n "${APP_PRIVATE_KEY}" ]] || { + echo "::error::WORKFLOW_SYNC_APP_CLIENT_ID and WORKFLOW_SYNC_APP_PRIVATE_KEY must be configured together" + exit 1 + } -+ elif [[ -n "\${LEGACY_APP_CLIENT_ID}" && -n "\${LEGACY_APP_PRIVATE_KEY}" ]]; then ++ elif [[ -n "${LEGACY_APP_CLIENT_ID}" && -n "${LEGACY_APP_PRIVATE_KEY}" ]]; then + echo "::notice::Legacy App credentials are supported for compatibility; migrate to WORKFLOW_SYNC_APP_*" + else + echo "::error::github-app requires WORKFLOW_SYNC_APP_CLIENT_ID and WORKFLOW_SYNC_APP_PRIVATE_KEY" @@ -83,7 +83,7 @@ + fi + ;; + token) -+ [[ -n "\${CONSUMER_TOKEN}" ]] || { ++ [[ -n "${CONSUMER_TOKEN}" ]] || { + echo "::error::token mode requires WORKFLOW_SYNC_TOKEN" + exit 1 + } @@ -91,21 +91,21 @@ + github-token) + ;; + *) -+ echo "::error::Unsupported WORKFLOW_SYNC_AUTH_MODE: \${AUTH_MODE}" ++ echo "::error::Unsupported WORKFLOW_SYNC_AUTH_MODE: ${AUTH_MODE}" + exit 1 + ;; + esac + + - name: Create GitHub App token -+ if: ${{ env.AUTH_MODE == 'github-app' || env.AUTH_MODE == 'librecode-app' } ++ if: ${{ env.AUTH_MODE == 'github-app' || env.AUTH_MODE == 'librecode-app' }} + id: workflow-app-token + uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510 # v3.3.0 - uses: skjnldsv/check-actor-permission@69e92a3c4711150929bca9fcf34448c5bf5526e7 # v3.0 with: -+ client-id: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID || vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID } -+ private-key: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY || secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY } -+ owner: ${{ github.repository_owner } -+ repositories: ${{ github.event.repository.name } ++ client-id: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID || vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID }} ++ private-key: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY || secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY }} ++ owner: ${{ github.repository_owner }} ++ repositories: ${{ github.event.repository.name }} + permission-contents: write + permission-pull-requests: write + permission-workflows: write @@ -114,26 +114,26 @@ + id: auth-token + shell: bash + env: -+ WORKFLOW_APP_TOKEN: ${{ steps.workflow-app-token.outputs.token } -+ CONSUMER_TOKEN: ${{ secrets.WORKFLOW_SYNC_TOKEN } -+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN } ++ WORKFLOW_APP_TOKEN: ${{ steps.workflow-app-token.outputs.token }} ++ CONSUMER_TOKEN: ${{ secrets.WORKFLOW_SYNC_TOKEN }} ++ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + set -euo pipefail + -+ case "\${AUTH_MODE}" in -+ github-app|librecode-app) token="\${WORKFLOW_APP_TOKEN}" ;; -+ token) token="\${CONSUMER_TOKEN}" ;; -+ github-token) token="\${GITHUB_TOKEN}" ;; ++ case "${AUTH_MODE}" in ++ github-app|librecode-app) token="${WORKFLOW_APP_TOKEN}" ;; ++ token) token="${CONSUMER_TOKEN}" ;; ++ github-token) token="${GITHUB_TOKEN}" ;; + *) exit 1 ;; + esac + -+ [[ -n "\${token}" ]] || { ++ [[ -n "${token}" ]] || { + echo "::error::Selected workflow sync authentication produced an empty token" + exit 1 + } + -+ echo "::add-mask::\${token}" -+ echo "token=\${token}" >> "\${GITHUB_OUTPUT}" ++ echo "::add-mask::${token}" ++ echo "token=${token}" >> "${GITHUB_OUTPUT}" - require: admin - name: Checkout workflow repository diff --git a/tests/test_workflow_sync_auth.py b/tests/test_workflow_sync_auth.py index 89098c6..9cd2f01 100644 --- a/tests/test_workflow_sync_auth.py +++ b/tests/test_workflow_sync_auth.py @@ -104,6 +104,11 @@ def test_validate_modes_and_credential_pairs(self) -> None: name + ": " + result.stderr + result.stdout, ) + def test_bash_and_github_expressions_are_well_formed(self) -> None: + self.assertNotIn(chr(92) + "$" + "{", self.content) + for line in self.content.splitlines(): + self.assertEqual(line.count("$" + "{{"), line.count("}}"), line) + def test_token_selection_is_shared(self) -> None: step = self.step("Resolve workflow sync token") self.assertIn("github-app|librecode-app)", step) diff --git a/workflow-templates/sync-workflow-templates.yml b/workflow-templates/sync-workflow-templates.yml index 39ac8ce..2ce0344 100644 --- a/workflow-templates/sync-workflow-templates.yml +++ b/workflow-templates/sync-workflow-templates.yml @@ -56,22 +56,22 @@ jobs: - name: Validate workflow sync authentication shell: bash env: - APP_CLIENT_ID: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID } - APP_PRIVATE_KEY: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY } - LEGACY_APP_CLIENT_ID: ${{ vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID } - LEGACY_APP_PRIVATE_KEY: ${{ secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY } - CONSUMER_TOKEN: ${{ secrets.WORKFLOW_SYNC_TOKEN } + APP_CLIENT_ID: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID }} + APP_PRIVATE_KEY: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY }} + LEGACY_APP_CLIENT_ID: ${{ vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID }} + LEGACY_APP_PRIVATE_KEY: ${{ secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY }} + CONSUMER_TOKEN: ${{ secrets.WORKFLOW_SYNC_TOKEN }} run: | set -euo pipefail - case "\${AUTH_MODE}" in + case "${AUTH_MODE}" in github-app|librecode-app) - if [[ -n "\${APP_CLIENT_ID}" || -n "\${APP_PRIVATE_KEY}" ]]; then - [[ -n "\${APP_CLIENT_ID}" && -n "\${APP_PRIVATE_KEY}" ]] || { + if [[ -n "${APP_CLIENT_ID}" || -n "${APP_PRIVATE_KEY}" ]]; then + [[ -n "${APP_CLIENT_ID}" && -n "${APP_PRIVATE_KEY}" ]] || { echo "::error::WORKFLOW_SYNC_APP_CLIENT_ID and WORKFLOW_SYNC_APP_PRIVATE_KEY must be configured together" exit 1 } - elif [[ -n "\${LEGACY_APP_CLIENT_ID}" && -n "\${LEGACY_APP_PRIVATE_KEY}" ]]; then + elif [[ -n "${LEGACY_APP_CLIENT_ID}" && -n "${LEGACY_APP_PRIVATE_KEY}" ]]; then echo "::notice::Legacy App credentials are supported for compatibility; migrate to WORKFLOW_SYNC_APP_*" else echo "::error::github-app requires WORKFLOW_SYNC_APP_CLIENT_ID and WORKFLOW_SYNC_APP_PRIVATE_KEY" @@ -79,7 +79,7 @@ jobs: fi ;; token) - [[ -n "\${CONSUMER_TOKEN}" ]] || { + [[ -n "${CONSUMER_TOKEN}" ]] || { echo "::error::token mode requires WORKFLOW_SYNC_TOKEN" exit 1 } @@ -87,20 +87,20 @@ jobs: github-token) ;; *) - echo "::error::Unsupported WORKFLOW_SYNC_AUTH_MODE: \${AUTH_MODE}" + echo "::error::Unsupported WORKFLOW_SYNC_AUTH_MODE: ${AUTH_MODE}" exit 1 ;; esac - name: Create GitHub App token - if: ${{ env.AUTH_MODE == 'github-app' || env.AUTH_MODE == 'librecode-app' } + if: ${{ env.AUTH_MODE == 'github-app' || env.AUTH_MODE == 'librecode-app' }} id: workflow-app-token uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510 # v3.3.0 with: - client-id: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID || vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID } - private-key: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY || secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY } - owner: ${{ github.repository_owner } - repositories: ${{ github.event.repository.name } + client-id: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID || vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID }} + private-key: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY || secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY }} + owner: ${{ github.repository_owner }} + repositories: ${{ github.event.repository.name }} permission-contents: write permission-pull-requests: write permission-workflows: write @@ -109,26 +109,26 @@ jobs: id: auth-token shell: bash env: - WORKFLOW_APP_TOKEN: ${{ steps.workflow-app-token.outputs.token } - CONSUMER_TOKEN: ${{ secrets.WORKFLOW_SYNC_TOKEN } - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN } + WORKFLOW_APP_TOKEN: ${{ steps.workflow-app-token.outputs.token }} + CONSUMER_TOKEN: ${{ secrets.WORKFLOW_SYNC_TOKEN }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | set -euo pipefail - case "\${AUTH_MODE}" in - github-app|librecode-app) token="\${WORKFLOW_APP_TOKEN}" ;; - token) token="\${CONSUMER_TOKEN}" ;; - github-token) token="\${GITHUB_TOKEN}" ;; + case "${AUTH_MODE}" in + github-app|librecode-app) token="${WORKFLOW_APP_TOKEN}" ;; + token) token="${CONSUMER_TOKEN}" ;; + github-token) token="${GITHUB_TOKEN}" ;; *) exit 1 ;; esac - [[ -n "\${token}" ]] || { + [[ -n "${token}" ]] || { echo "::error::Selected workflow sync authentication produced an empty token" exit 1 } - echo "::add-mask::\${token}" - echo "token=\${token}" >> "\${GITHUB_OUTPUT}" + echo "::add-mask::${token}" + echo "token=${token}" >> "${GITHUB_OUTPUT}" - name: Checkout workflow repository uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 From f49bf6437080f0b58be6addbba592e1a016927d2 Mon Sep 17 00:00:00 2001 From: Vitor Mattos <1079143+vitormattos@users.noreply.github.com> Date: Wed, 18 Nov 2026 02:35:35 +0000 Subject: [PATCH 5/7] refactor(ci): remove branded authentication aliases and require generic settings Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com> --- docs/cross-repository-automation.md | 48 +++----- patches/nextcloud/npm-audit-fix.yml.patch | 4 +- .../sync-workflow-templates.yml.patch | 27 ++-- tests/test_workflow_sync_auth.py | 115 +++++++----------- workflow-templates/npm-audit-fix.yml | 4 +- .../sync-workflow-templates.yml | 23 ++-- 6 files changed, 78 insertions(+), 143 deletions(-) diff --git a/docs/cross-repository-automation.md b/docs/cross-repository-automation.md index 0f52780..78bf13c 100644 --- a/docs/cross-repository-automation.md +++ b/docs/cross-repository-automation.md @@ -26,34 +26,20 @@ The updater manages workflows already installed in the consumer repository. It r ## Authentication -The workflow has a provider-neutral interface. Set the repository variable -`WORKFLOW_SYNC_AUTH_MODE` to choose a credential source: - -- `github-app` (default) — preferred. Configure variable - `WORKFLOW_SYNC_APP_CLIENT_ID` and secret `WORKFLOW_SYNC_APP_PRIVATE_KEY`. -- `token` — configure secret `WORKFLOW_SYNC_TOKEN`. -- `github-token` — use the workflow's built-in `GITHUB_TOKEN`. - -A consumer-owned GitHub App is recommended. It needs repository permissions -**Contents: write**, **Pull requests: write** and **Workflows: write** -to update files under `.github/workflows`. - -### Compatibility with existing consumers - -The former `librecode-app` mode is still accepted as an alias for `github-app`. -If the generic App credentials are absent, the workflow also accepts the -previous `LIBRECODE_WORKFLOW_APP_CLIENT_ID` variable and -`LIBRECODE_WORKFLOW_APP_PRIVATE_KEY` secret. This is a compatibility fallback, -not a requirement for new consumers. Both generic credentials must be configured -together; a partially configured generic pair fails validation rather than -mixing credentials from different Apps. - -To migrate an existing consumer, configure the generic variable and secret as -a pair, change any explicit `librecode-app` mode to `github-app`, verify one -sync run, and only then retire the previous values. The organization hosting -the catalog is independent of the App used by the consumer. - -`github-token` remains an explicit choice because events created with +The workflow uses organization-neutral settings; each consumer can select its +own credentials. Configure `WORKFLOW_SYNC_AUTH_MODE` as: + +- `github-app` (default) — `WORKFLOW_SYNC_APP_CLIENT_ID` (repository variable) + and `WORKFLOW_SYNC_APP_PRIVATE_KEY` (Actions secret). +- `token` — `WORKFLOW_SYNC_TOKEN` (Actions secret). +- `github-token` — the built-in `GITHUB_TOKEN`. + +The `github-app` mode requires the complete variable/secret pair; it fails +before any write when either value is missing. Use a consumer-owned GitHub App +with **Contents: write**, **Pull requests: write**, and **Workflows: write** +permissions to update files under `.github/workflows`. + +The `github-token` mode is explicit because events emitted using `GITHUB_TOKEN` may not trigger normal pull-request automation. ## Install and update workflows @@ -106,12 +92,12 @@ Generated or experimental workflows should not be added until they are ready for For the npm audit workflow, consumers need a matching local patch and configured GitHub App credentials before enrollment. -## LibreCode catalog credentials +## Catalog credentials Catalog publication uses the **LibreCode Workflow Automation** GitHub App. Its credentials are stored in `LibreCodeCoop/.github`: -- variable `LIBRECODE_WORKFLOW_APP_CLIENT_ID` (GitHub App Client ID); -- secret `LIBRECODE_WORKFLOW_APP_PRIVATE_KEY`. +- variable `WORKFLOW_SYNC_APP_CLIENT_ID` (GitHub App Client ID); +- secret `WORKFLOW_SYNC_APP_PRIVATE_KEY`. Write-capable jobs mint short-lived installation tokens scoped to the destination repository. The private key must never be committed. diff --git a/patches/nextcloud/npm-audit-fix.yml.patch b/patches/nextcloud/npm-audit-fix.yml.patch index 0ce3480..dd1bcd4 100644 --- a/patches/nextcloud/npm-audit-fix.yml.patch +++ b/patches/nextcloud/npm-audit-fix.yml.patch @@ -113,8 +113,8 @@ + if: steps.checkout.outcome == 'success' + uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510 # v3.3.0 + with: -+ client-id: ${{ vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID }} -+ private-key: ${{ secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY }} ++ client-id: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID }} ++ private-key: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY }} + owner: ${{ github.repository_owner }} + repositories: ${{ github.event.repository.name }} + permission-contents: write diff --git a/patches/nextcloud/sync-workflow-templates.yml.patch b/patches/nextcloud/sync-workflow-templates.yml.patch index 4dcdf50..6bd3752 100644 --- a/patches/nextcloud/sync-workflow-templates.yml.patch +++ b/patches/nextcloud/sync-workflow-templates.yml.patch @@ -36,7 +36,7 @@ name: Update workflows in ${{ matrix.branches }} -@@ -36,18 +36,112 @@ +@@ -36,18 +36,103 @@ contents: write pull-requests: write @@ -62,25 +62,16 @@ + env: + APP_CLIENT_ID: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID }} + APP_PRIVATE_KEY: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY }} -+ LEGACY_APP_CLIENT_ID: ${{ vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID }} -+ LEGACY_APP_PRIVATE_KEY: ${{ secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY }} + CONSUMER_TOKEN: ${{ secrets.WORKFLOW_SYNC_TOKEN }} + run: | + set -euo pipefail + + case "${AUTH_MODE}" in -+ github-app|librecode-app) -+ if [[ -n "${APP_CLIENT_ID}" || -n "${APP_PRIVATE_KEY}" ]]; then -+ [[ -n "${APP_CLIENT_ID}" && -n "${APP_PRIVATE_KEY}" ]] || { -+ echo "::error::WORKFLOW_SYNC_APP_CLIENT_ID and WORKFLOW_SYNC_APP_PRIVATE_KEY must be configured together" -+ exit 1 -+ } -+ elif [[ -n "${LEGACY_APP_CLIENT_ID}" && -n "${LEGACY_APP_PRIVATE_KEY}" ]]; then -+ echo "::notice::Legacy App credentials are supported for compatibility; migrate to WORKFLOW_SYNC_APP_*" -+ else ++ github-app) ++ [[ -n "${APP_CLIENT_ID}" && -n "${APP_PRIVATE_KEY}" ]] || { + echo "::error::github-app requires WORKFLOW_SYNC_APP_CLIENT_ID and WORKFLOW_SYNC_APP_PRIVATE_KEY" + exit 1 -+ fi ++ } + ;; + token) + [[ -n "${CONSUMER_TOKEN}" ]] || { @@ -97,13 +88,13 @@ + esac + + - name: Create GitHub App token -+ if: ${{ env.AUTH_MODE == 'github-app' || env.AUTH_MODE == 'librecode-app' }} ++ if: ${{ env.AUTH_MODE == 'github-app' }} + id: workflow-app-token + uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510 # v3.3.0 - uses: skjnldsv/check-actor-permission@69e92a3c4711150929bca9fcf34448c5bf5526e7 # v3.0 with: -+ client-id: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID || vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID }} -+ private-key: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY || secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY }} ++ client-id: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID }} ++ private-key: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY }} + owner: ${{ github.repository_owner }} + repositories: ${{ github.event.repository.name }} + permission-contents: write @@ -121,7 +112,7 @@ + set -euo pipefail + + case "${AUTH_MODE}" in -+ github-app|librecode-app) token="${WORKFLOW_APP_TOKEN}" ;; ++ github-app) token="${WORKFLOW_APP_TOKEN}" ;; + token) token="${CONSUMER_TOKEN}" ;; + github-token) token="${GITHUB_TOKEN}" ;; + *) exit 1 ;; @@ -152,7 +143,7 @@ - name: Checkout app uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 -@@ -56,112 +150,31 @@ +@@ -56,112 +141,31 @@ path: target ref: ${{ matrix.branches }} diff --git a/tests/test_workflow_sync_auth.py b/tests/test_workflow_sync_auth.py index 9cd2f01..8f22def 100644 --- a/tests/test_workflow_sync_auth.py +++ b/tests/test_workflow_sync_auth.py @@ -1,7 +1,7 @@ # SPDX-FileCopyrightText: 2026 LibreCode coop and contributors # SPDX-License-Identifier: AGPL-3.0-or-later -"""Regression tests for provider-neutral workflow authentication.""" +"""Authentication contract for provider-neutral workflow synchronization.""" import os import re @@ -25,98 +25,65 @@ def step(self, name: str) -> str: text = self.content.split(" - name: " + name + "\n", 1)[1] return text.split(" - name: ", 1)[0] - def validation_script(self) -> str: - step = self.step("Validate workflow sync authentication") - script = step.split(" run: |\n", 1)[1] - return "\n".join( - line[10:] if line.startswith(" ") else line - for line in script.splitlines() - ) + "\n" - - def test_public_default_and_one_app_step(self) -> None: + def test_default_mode_and_app_action(self) -> None: self.assertIn( "AUTH_MODE: " + "$" + "{{ vars.WORKFLOW_SYNC_AUTH_MODE || 'github-app' }}", self.content, ) - self.assertEqual( - self.content.count(" - name: Create GitHub App token\n"), 1 - ) - self.assertNotIn(" - name: Create LibreCode GitHub App token\n", - self.content) - self.assertNotIn(" - name: Create consumer GitHub App token\n", - self.content) + action = self.step("Create GitHub App token") + self.assertIn("env.AUTH_MODE == 'github-app'", action) + self.assertIn("vars.WORKFLOW_SYNC_APP_CLIENT_ID", action) + self.assertIn("secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY", action) + self.assertEqual(self.content.count(" - name: Create GitHub App token\n"), 1) + + def test_resolver_uses_one_app_token(self) -> None: + action = self.step("Resolve workflow sync token") + self.assertIn('github-app) token="' + "$" + '{WORKFLOW_APP_TOKEN}"', action) + self.assertIn('token) token="' + "$" + '{CONSUMER_TOKEN}"', action) + self.assertIn('github-token) token="' + "$" + '{GITHUB_TOKEN}"', action) + self.assertIn("steps.workflow-app-token.outputs.token", action) self.assertEqual( len(re.findall(r"^\s*AUTH_MODE:", self.content, re.MULTILINE)), 1 ) - def test_app_gate_and_credential_precedence(self) -> None: - step = self.step("Create GitHub App token") - self.assertIn( - "env.AUTH_MODE == 'github-app' || env.AUTH_MODE == 'librecode-app'", - step, - ) - self.assertIn( - "vars.WORKFLOW_SYNC_APP_CLIENT_ID || " - "vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID", step, - ) - self.assertIn( - "secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY || " - "secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY", step, - ) - self.assertEqual(self.content.count("id: workflow-app-token"), 1) - self.assertIn("steps.workflow-app-token.outputs.token", - self.step("Resolve workflow sync token")) - - def test_validate_modes_and_credential_pairs(self) -> None: - script = self.validation_script() - fixtures = ( - # name, mode, generic ID/key, legacy ID/key, token, success - ("generic default", "github-app", "id", "key", "", "", "", True), - ("legacy fallback", "github-app", "", "", "old-id", "old-key", "", True), - ("legacy mode", "librecode-app", "", "", "old-id", "old-key", "", True), - ("generic preferred", "github-app", "id", "key", "old-id", - "old-key", "", True), - ("partial generic ID", "github-app", "id", "", "old-id", - "old-key", "", False), - ("partial generic key", "github-app", "", "key", "old-id", - "old-key", "", False), - ("missing app credentials", "github-app", "", "", "", "", "", False), - ("partial legacy ID", "github-app", "", "", "old-id", "", "", False), - ("partial legacy key", "github-app", "", "", "", "old-key", "", False), - ("token", "token", "", "", "", "", "token-value", True), - ("missing token", "token", "", "", "", "", "", False), - ("github-token", "github-token", "", "", "", "", "", True), - ("unsupported", "unrecognized", "", "", "", "", "", False), + def test_validate_credential_modes(self) -> None: + step = self.step("Validate workflow sync authentication") + script = step.split(" run: |\n", 1)[1] + script = "\n".join( + line[10:] if line.startswith(" ") else line + for line in script.splitlines() + ) + "\n" + cases = ( + ("app valid", "github-app", "client-id", "key", "", True), + ("app missing id", "github-app", "", "key", "", False), + ("app missing key", "github-app", "client-id", "", "", False), + ("app missing both", "github-app", "", "", "", False), + ("token valid", "token", "", "", "opaque", True), + ("token missing", "token", "", "", "", False), + ("github token", "github-token", "", "", "", True), + ("unsupported mode", "unknown", "", "", "", False), ) - for name, mode, gid, gkey, lid, lkey, token, expected in fixtures: + for name, mode, client_id, private_key, token, ok in cases: with self.subTest(case=name): - env = dict(os.environ, AUTH_MODE=mode, - APP_CLIENT_ID=gid, APP_PRIVATE_KEY=gkey, - LEGACY_APP_CLIENT_ID=lid, - LEGACY_APP_PRIVATE_KEY=lkey, - CONSUMER_TOKEN=token) + env = dict( + os.environ, AUTH_MODE=mode, + APP_CLIENT_ID=client_id, APP_PRIVATE_KEY=private_key, + CONSUMER_TOKEN=token, + ) result = subprocess.run( - ["bash", "-e", "-c", script], env=env, text=True, - capture_output=True, check=False, + ["bash", "-e", "-c", script], env=env, + capture_output=True, text=True, check=False, ) self.assertEqual( - result.returncode == 0, expected, - name + ": " + result.stderr + result.stdout, + result.returncode == 0, ok, + name + ": " + result.stdout + result.stderr, ) - def test_bash_and_github_expressions_are_well_formed(self) -> None: + def test_action_expressions_are_well_formed(self) -> None: self.assertNotIn(chr(92) + "$" + "{", self.content) for line in self.content.splitlines(): self.assertEqual(line.count("$" + "{{"), line.count("}}"), line) - def test_token_selection_is_shared(self) -> None: - step = self.step("Resolve workflow sync token") - self.assertIn("github-app|librecode-app)", step) - self.assertIn('token="' + '$' + '{WORKFLOW_APP_TOKEN}"', step) - self.assertIn('token="' + '$' + '{CONSUMER_TOKEN}"', step) - self.assertIn('token="' + '$' + '{GITHUB_TOKEN}"', step) - self.assertNotIn("LIBRECODE_APP_TOKEN", step) - if __name__ == "__main__": unittest.main() diff --git a/workflow-templates/npm-audit-fix.yml b/workflow-templates/npm-audit-fix.yml index 5f7048d..92c92c5 100644 --- a/workflow-templates/npm-audit-fix.yml +++ b/workflow-templates/npm-audit-fix.yml @@ -74,8 +74,8 @@ jobs: if: steps.checkout.outcome == 'success' uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510 # v3.3.0 with: - client-id: ${{ vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID }} - private-key: ${{ secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY }} + client-id: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID }} + private-key: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY }} owner: ${{ github.repository_owner }} repositories: ${{ github.event.repository.name }} permission-contents: write diff --git a/workflow-templates/sync-workflow-templates.yml b/workflow-templates/sync-workflow-templates.yml index 2ce0344..e558c96 100644 --- a/workflow-templates/sync-workflow-templates.yml +++ b/workflow-templates/sync-workflow-templates.yml @@ -58,25 +58,16 @@ jobs: env: APP_CLIENT_ID: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID }} APP_PRIVATE_KEY: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY }} - LEGACY_APP_CLIENT_ID: ${{ vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID }} - LEGACY_APP_PRIVATE_KEY: ${{ secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY }} CONSUMER_TOKEN: ${{ secrets.WORKFLOW_SYNC_TOKEN }} run: | set -euo pipefail case "${AUTH_MODE}" in - github-app|librecode-app) - if [[ -n "${APP_CLIENT_ID}" || -n "${APP_PRIVATE_KEY}" ]]; then - [[ -n "${APP_CLIENT_ID}" && -n "${APP_PRIVATE_KEY}" ]] || { - echo "::error::WORKFLOW_SYNC_APP_CLIENT_ID and WORKFLOW_SYNC_APP_PRIVATE_KEY must be configured together" - exit 1 - } - elif [[ -n "${LEGACY_APP_CLIENT_ID}" && -n "${LEGACY_APP_PRIVATE_KEY}" ]]; then - echo "::notice::Legacy App credentials are supported for compatibility; migrate to WORKFLOW_SYNC_APP_*" - else + github-app) + [[ -n "${APP_CLIENT_ID}" && -n "${APP_PRIVATE_KEY}" ]] || { echo "::error::github-app requires WORKFLOW_SYNC_APP_CLIENT_ID and WORKFLOW_SYNC_APP_PRIVATE_KEY" exit 1 - fi + } ;; token) [[ -n "${CONSUMER_TOKEN}" ]] || { @@ -93,12 +84,12 @@ jobs: esac - name: Create GitHub App token - if: ${{ env.AUTH_MODE == 'github-app' || env.AUTH_MODE == 'librecode-app' }} + if: ${{ env.AUTH_MODE == 'github-app' }} id: workflow-app-token uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510 # v3.3.0 with: - client-id: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID || vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID }} - private-key: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY || secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY }} + client-id: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID }} + private-key: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY }} owner: ${{ github.repository_owner }} repositories: ${{ github.event.repository.name }} permission-contents: write @@ -116,7 +107,7 @@ jobs: set -euo pipefail case "${AUTH_MODE}" in - github-app|librecode-app) token="${WORKFLOW_APP_TOKEN}" ;; + github-app) token="${WORKFLOW_APP_TOKEN}" ;; token) token="${CONSUMER_TOKEN}" ;; github-token) token="${GITHUB_TOKEN}" ;; *) exit 1 ;; From 14c56761c04f5aa4e594a1f2227a3b6419450b88 Mon Sep 17 00:00:00 2001 From: Vitor Mattos <1079143+vitormattos@users.noreply.github.com> Date: Wed, 18 Nov 2026 02:36:50 +0000 Subject: [PATCH 6/7] test(ci): require generic App credentials for npm audit workflow Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com> --- tests/test_npm_audit_workflow_contract.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/test_npm_audit_workflow_contract.py b/tests/test_npm_audit_workflow_contract.py index 3d48fd2..9f283ca 100644 --- a/tests/test_npm_audit_workflow_contract.py +++ b/tests/test_npm_audit_workflow_contract.py @@ -50,8 +50,8 @@ def test_read_only_workflow_with_scoped_short_lived_app_token(self) -> None: content = self.content self.assertIn("permissions:\n contents: read\n", content) self.assertIn("uses: actions/create-github-app-token@", content) - self.assertIn("client-id: ${{ vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID }}", content) - self.assertIn("private-key: ${{ secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY }}", content) + self.assertIn("client-id: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID }}", content) + self.assertIn("private-key: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY }}", content) self.assertIn("permission-contents: write", content) self.assertIn("permission-pull-requests: write", content) self.assertIn("token: ${{ steps.app-token.outputs.token }}", content) From 190c876b537861ef704967959ad76f4e7b46050f Mon Sep 17 00:00:00 2001 From: Vitor Mattos <1079143+vitormattos@users.noreply.github.com> Date: Wed, 18 Nov 2026 02:46:53 +0000 Subject: [PATCH 7/7] ci: use generic App credentials in catalog upstream refresh Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com> --- .github/workflows/upstream-refresh.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/upstream-refresh.yml b/.github/workflows/upstream-refresh.yml index 1d071e1..a79b831 100644 --- a/.github/workflows/upstream-refresh.yml +++ b/.github/workflows/upstream-refresh.yml @@ -22,15 +22,15 @@ jobs: steps: - name: Validate GitHub App configuration env: - WORKFLOW_APP_CLIENT_ID: ${{ vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID }} - WORKFLOW_APP_PRIVATE_KEY: ${{ secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY }} + WORKFLOW_APP_CLIENT_ID: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID }} + WORKFLOW_APP_PRIVATE_KEY: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY }} run: | if [ -z "$WORKFLOW_APP_CLIENT_ID" ]; then - echo "::error::LIBRECODE_WORKFLOW_APP_CLIENT_ID is not configured." + echo "::error::WORKFLOW_SYNC_APP_CLIENT_ID is not configured." exit 1 fi if [ -z "$WORKFLOW_APP_PRIVATE_KEY" ]; then - echo "::error::LIBRECODE_WORKFLOW_APP_PRIVATE_KEY is not configured." + echo "::error::WORKFLOW_SYNC_APP_PRIVATE_KEY is not configured." exit 1 fi @@ -38,8 +38,8 @@ jobs: id: app-token uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510 # v3.3.0 with: - client-id: ${{ vars.LIBRECODE_WORKFLOW_APP_CLIENT_ID }} - private-key: ${{ secrets.LIBRECODE_WORKFLOW_APP_PRIVATE_KEY }} + client-id: ${{ vars.WORKFLOW_SYNC_APP_CLIENT_ID }} + private-key: ${{ secrets.WORKFLOW_SYNC_APP_PRIVATE_KEY }} owner: LibreCodeCoop repositories: .github permission-contents: write