Skip to content

docs: add the guide to signing commits with an SSH key - #6

Merged
estefano-vechietti-azion merged 1 commit into
mainfrom
docs/commit-signing
Nov 3, 2026
Merged

estefano-vechietti-azion merged 1 commit into
mainfrom
docs/commit-signing

Conversation

@estefano-vechietti-azion

Copy link
Copy Markdown
Contributor

What changes

  • New docs/commit-signing.md. A step-by-step guide to signing commits with an SSH key, ahead of the organization requiring verified signatures on protected branches. It covers:
    • creating the key and configuring git;
    • adding the key to GitHub as a Signing Key, the step most often missed;
    • verifying the result locally and on GitHub;
    • remote setups (Coder, devcontainers, SSH through the forwarded agent) and 1Password;
    • re-signing a branch and handling automations that commit;
    • a table of common problems, keyed by the verification reason.
  • CONTRIBUTING.md: a new item 7 links the guide, with an absolute URL because this CONTRIBUTING.md is the default for every repository.
  • README.md: lists the guide as a file that is not inherited.

The guide covers SSH only, because every signing key registered in the organization today is an SSH key.

Not in this PR

  • The date the rule is enforced. It is announced separately.
  • A support channel. The guide points to @aziontech/team-delivery-engineering.

🤖 Generated with Claude Code

Protected branches in the organization will require verified commit
signatures. The guide covers creating the key, configuring git, adding
the key to GitHub as a Signing Key, verifying the result, remote and
1Password setups, re-signing a branch, automations that commit, and the
common failures by verification reason. SSH only: every signing key
registered in the organization today is an SSH key.

CONTRIBUTING.md links it; README.md lists it as not inherited.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@estefano-vechietti-azion
estefano-vechietti-azion requested a review from a team as a code owner November 3, 2026 14:36
@estefano-vechietti-azion
estefano-vechietti-azion merged commit 85e90cb into main Nov 3, 2026
1 check passed
@estefano-vechietti-azion
estefano-vechietti-azion deleted the docs/commit-signing branch November 3, 2026 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant