Skip to content

Commit

Permalink
Update GitHub - add commit signing
Browse files Browse the repository at this point in the history
  • Loading branch information
ahosgood committed Sep 20, 2023
1 parent 3e2a130 commit ff8a5d9
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docs/third-party/github.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# GitHub

1. **Branch protection**
1. The main branch should be called `main`
1. The main branch SHOULD be called `main`
1. The main branch in public repositories MUST be protected such that:
- A pull request is required before merging
- At least 1 reviewer's approval is required to merge
- Signed commits are required
- [Signed commits](#commit-signing) are required
1. The main branch in public repositories SHOULD be protected such that:
- "Do not allow bypassing the above settings" is enabled
1. The main branch in public repositories COULD be protected such that:
- Dismiss stale pull request approvals when new commits are pushed
- Require status checks to pass before merging - Note that pre-commit should be a check that always passes and any testing that must pass can also be easily enforced with the checks mechanism
- Require branches to be up to date before merging - a sub option of the above (this can still be enabled even if there are no checks present)
Expand All @@ -16,6 +16,10 @@
1. **Archiving projects/making read-only**
1. Once no longer maintained, teams SHOULD [archive repositories](https://docs.github.com/en/repositories/archiving-a-github-repository/archiving-repositories)

## Commit signing

- https://github.com/microsoft/vscode/wiki/Commit-Signing

## GitHub Actions

[Deployment](../../ways-of-working/deployment/)

0 comments on commit ff8a5d9

Please sign in to comment.