Skip to content

Commit 42951aa

Browse files
chore: update the audit template (#20)
Signed-off-by: Andrew Brandt <[email protected]>
1 parent a0a75f7 commit 42951aa

File tree

1 file changed

+23
-18
lines changed

1 file changed

+23
-18
lines changed

audit_template.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,13 @@ If actions have run in the last 6 months then actions shall remain enabled:
4747

4848
### Rules/Rulesets Tab
4949
- [ ] The repository uses the current rulesets
50+
- [ ] If appropriate, global rules are enabled/disabled for the repo
5051

5152
### Actions Tab
5253
**If actions are enabled**:
5354
- [ ] Codecov is enabled on the repository
55+
- [ ] Title check is enabled
56+
- [ ] DCO check is enabled
5457

5558
### Webhooks Tab
5659
- [ ] All webhooks present are needed and in use
@@ -66,23 +69,27 @@ If actions have run in the last 6 months then actions shall remain enabled:
6669
### GitHub Apps
6770
- [ ] Code Coverage Reporting
6871
- [ ] CodeQL is enabled on the repository
72+
- [ ] Codacy is enabled on the repository
6973

7074
## App Integrations
7175
- [ ] Dependabot is configured to monitor all relevant ecosystems (verify through `dependabot.yaml` file)
72-
- npm
73-
- electron
74-
- github actions
75-
- etc.
76+
- Link to [relevant ecosystems](https://docs.github.com/en/code-security/dependabot/ecosystems-supported-by-dependabot/supported-ecosystems-and-repositories)
7677
- [ ] DCO-2 is configured as the DCO check
7778

78-
### Code Formatting
79-
- [ ] NodeJS Projects use ESLint/Prettier formatting
80-
- [ ] Java Projects use Checkstyle/Spotless formatting
81-
- [ ] CPP Projects use Clang Tidy
79+
## Code Formatting
80+
- [ ] NodeJS Projects use ESLint/Prettier formatting
81+
- [ ] Java Projects use Checkstyle/Spotless formatting
82+
- [ ] CPP Projects use Clang Tidy
83+
- [ ] Rust
84+
- [ ] Swift
85+
- [ ] Go
86+
87+
## CODEOWNERS
88+
- [ ] `.github/CODEOWNERS` is valid and up-to-date
8289

8390
# Workflow Audit Criteria
8491

85-
### Security Checks in Workflows
92+
## Security Checks in Workflows
8693
- [ ] Secrets Management In Workflow Files (`/.github/workflows/`)
8794
- [ ] No hardcoded secrets in the workflow files or code
8895
- [ ] Secrets are referenced in CI via config files or environment variables
@@ -91,24 +98,22 @@ If actions have run in the last 6 months then actions shall remain enabled:
9198
- integrity checks should use either checksums or cryptographic hashes for verification
9299
- [ ] Checksums/hashes are verified during CI process to detect unauthorized changes
93100
- [ ] Expected checksums/hashes are stored securely and referenced through the CI pipeline
101+
- [ ] Use pinned versions of Docker files
94102
- [ ] `npx playwright install deps` is used to install OS dependencies instead of `aptitude`
95103

96-
### Workflow checks
104+
## Workflow checks
97105

98-
- [ ] Appropriate permissions are set within the github workflows
106+
- [ ] Appropriate permissions are set within the GitHub workflows
99107
- [ ] All steps are named
100108
- [ ] All workflow actions are using pinned commits
101-
- [ ] The Step-Security Hardened Security action is enabled on each workflow job
109+
- [ ] The step-security hardened security action is enabled on each workflow job
110+
- [ ] If the step-security dashboard reports action with score of <6, request a step-security version of the action
102111

103-
### Self Hosted Runners
112+
## Self Hosted Runners
104113

105114
- [ ] The Repository is using the latitude runner group label for the `runs-on` stanza
106115

107-
### CODEOWNERS
108-
109-
- [ ] `.github/CODEOWNERS` is valid and up-to-date
110-
111-
### Other
116+
## Other
112117

113118
- [ ] *If Applicable*: Alert repository owners of software versions that are no longer supported
114119
- [ ] *If Applicable*: Alert repository owners when software versions are within 3 months of losing support

0 commit comments

Comments
 (0)