You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: skills/github-repo-setup/SKILL.md
+47-1Lines changed: 47 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -66,4 +66,50 @@ Evaluate repository compliance against contractually mandated BC Gov DevOps and
66
66
-**Vulnerability SLAs**: Critical findings (24 hours), High (1 week), Medium (2 weeks), Low (next sprint).
67
67
68
68
## Output Format
69
-
Always generate a `MATURITY_REPORT.md` file in the root of the audited repository following the schema defined in `resources/REPORT_TEMPLATE.md`. Ensure that check boxes are marked with `[x]` (Met) or `[ ]` (Not Met/Missing) and a clear, descriptive breakdown of recommendations is presented.
69
+
Always generate a `MATURITY_REPORT.md` file in the root of the audited repository following the schema defined in `resources/REPORT_TEMPLATE.md`. Ensure that check boxes are marked with `[x]` (Met) or `[ ]` (Not Met/Missing) and a clear, descriptive breakdown of recommendations is presented.
70
+
71
+
## Examples
72
+
73
+
### Example 1: Assessment of a Production Microservice
74
+
**Input**: Repository URL: `bcgov/my-api-service`
75
+
**Process**:
76
+
1. Walk repository: Find `package.json` with TypeScript, `tsconfig.json`, `renovate.json`, `.github/workflows/`, and `openshift.deploy.yml`.
77
+
2. Check TypeScript strictness: Verify `strict: true` in `tsconfig.json`.
78
+
3. Run `npm audit` and check for bypasses (`@ts-ignore`, `eslint-disable`).
79
+
4. Inspect Renovate config: Local `renovate.json` extends `github>bcgov/renovate-config#2026.04`. Fetch inherited preset and verify effective automerge, schedule, and minimumReleaseAge.
**Output**: `MATURITY_REPORT.md` with clear Tier 1 (blocking) and Tier 2 (recommended) actions.
97
+
98
+
## Edge Cases
99
+
100
+
-**Monorepos with Multiple `tsconfig.json` Files**: Inspect root `tsconfig.json` and any workspace-level configurations. Flag inconsistencies in strictness across packages.
101
+
-**Renovate Config Missing Extends**: If `renovate.json` exists but has no `extends`, note that default Renovate behavior applies (no inherited presets). Verify manual configuration is comprehensive.
102
+
-**GitHub API Unavailable**: Use manual inspection (cloning repo, reading workflows, grepping code) when GitHub API tools are unavailable. Document limitations in the report.
103
+
-**Non-TypeScript Repositories**: Skip TypeScript-specific rules (strict mode, `@ts-ignore`). Assess applicable language-specific linting (ESLint for JavaScript, Pylint for Python, etc.).
104
+
-**Legacy Branch Names (`master`, `develop`)**: Audit still applies. Flag as a low-priority gap if org standards require `main`.
105
+
-**Exempt Repositories**: Repositories that are documentation-only, archived, or experimental should be skipped with a clear note in the report.
0 commit comments