Repository navigation
feat(automation): sign config-sync and APM PR commits through the API - #538
Merged
Merged
Conversation
config-sync, apm-sync and apm-materialize opened their PRs with open-pr v3.3.0, which pushes unsigned commits, so every one of those PRs is blocked by the required_signatures ruleset. Bump open-pr to v4.1.0 and set commit-method: api, so GitHub signs the commits (with the App token and with the GITHUB_TOKEN fallback). open-pr no longer runs git push in these jobs, so the calling-repository checkouts stop persisting credentials and drop their zizmor artipacked ignores. Refs #488 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 2 minutes. View limit details
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. |
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues block the signed-commit workflow changes.
No open issues 🎉
What changed in this PR
This PR enables GitHub-signed commits for the shared config-sync and APM PR workflows, addressing the signed-commit requirement tracked in #488 using the API support added in #517.
Changes:
- Upgrade
open-prfrom v3.3.0 to v4.1.0 and setcommit-method: apiin all three workflows. - Disable persisted checkout credentials and remove the associated security-linter suppressions.
- Document signed commits, including when using the
GITHUB_TOKENfallback.
| File | Description |
|---|---|
docs/automation-app.md |
Document API-backed signing and fallback-token behavior. |
.github/workflows/config-sync.yml |
Enable signed API commits and disable persisted checkout credentials. |
.github/workflows/apm-sync.yml |
Enable signed API commits and disable persisted checkout credentials. |
.github/workflows/apm-materialize.yml |
Enable signed API commits and disable persisted checkout credentials. |
Review effort: Balanced
This was referenced Nov 16, 2026
Merged
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
config-sync,apm-syncandapm-materializeopen their PRs withopen-prv3.3.0, which pushes unsigned commits. Every one of those PRs is then blocked by therequired_signaturesruleset (for example DevSecNinja/note-iq#39 and DevSecNinja/vidaud#186). This PR bumpsopen-prto v4.1.0, which includes #517, and setscommit-method: api. GitHub signs commits made throughcreateCommitOnBranch, both with the Automation App token and with theGITHUB_TOKENfallback.Because
open-prno longer runsgit pushin these jobs, the calling-repository checkouts now usepersist-credentials: false. That also removes theirzizmor: ignore[artipacked]suppressions. No other step in these jobs needs git credentials:ghusesGH_TOKEN, andapmfetches packages into its own clones.Fleet rollout: a repo picks this up once its
config-sync.ymlcaller pin moves to the release that contains this PR. After that,gh workflow run config-sync.yml -R DevSecNinja/<repo>replaces the unsigned commit onchore/config-syncwith a signed one in the same PR, even when the synced files haven't changed (#517 replaces an identical but unsigned tip).Refs #488
Changes
.github/workflows/config-sync.yml,apm-sync.yml,apm-materialize.yml:open-prpinv3.3.0→v4.1.0(5cee546),commit-method: api, andpersist-credentials: falseon the calling-repository checkout.docs/automation-app.md: notes that these workflows' commits are signed, including on theGITHUB_TOKENfallback.Changes to
open-pritself between the two pins: #484 (create missing labels) and #517 (commit-method).Validation
uv run --script tests/app-key-confinement.py: passed (32 workflows; the emptiness-check hashes are unchanged).bash tests/automation-app-contract.sh,open-pr-api-commit.sh,open-pr-push.sh,open-pr-labels.sh,config-sync-ai-toolkit-instructions.sh,lint-job-modes-contract.sh,release-please-auth-contract.sh,copilot-model-policy-contract.sh,pages-custom-domain-contract.sh: passed.python3 tests/workflow-job-conditions.py: passed.renovate-*,config-sync-renovate-stub,config-sync-lint-excludes,gitleaks-configandlint-gitleaks-reporttests. This PR doesn't touch them, and CI runsmise run test.zizmor --offline,yamllint,yamlfmt -linton the three workflows anddprint checkon the doc: clean.Checklist