forked from groombook/org
Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 5d39685451 | |||
| 36310c48db | |||
| 738f5d8f05 | |||
| cffa73cd97 | |||
| cd5d9c5614 | |||
| 40f8153c86 |
@@ -3,8 +3,9 @@ name: coding-standards
|
||||
description: >
|
||||
Engineering quality bar for GroomBook code: priority ordering of correctness
|
||||
vs. clarity vs. maintainability vs. performance vs. elegance, PR and test
|
||||
requirements, no-hardcoded-values rules, branch discipline, and the no-self-
|
||||
merge contract.
|
||||
requirements, no-hardcoded-values rules, branch discipline, and the
|
||||
no-self-merge contract. The uat→main merge-gate policy lives in the `sdlc`
|
||||
skill, not here.
|
||||
---
|
||||
|
||||
# Coding Standards
|
||||
@@ -24,7 +25,7 @@ When making technical decisions, prioritize in this order:
|
||||
## Pull request discipline
|
||||
|
||||
* All changes go through a PR. **Never push directly to `dev`, `uat`, or `main`.**
|
||||
* No agent merges their own PR.
|
||||
* Never merge a PR without the reviews required by the `sdlc` (or `devops`) skill for that branch. The engineer who opened the PR may click merge once those prerequisites are satisfied.
|
||||
* Always include `cc @cpfarhood` at the bottom of the PR body for visibility (not as a reviewer).
|
||||
|
||||
## Test requirements
|
||||
@@ -57,6 +58,10 @@ All releases use CalVer (`YYYY.MMDD.PATCH`, e.g. `2026.0504.0`). No SemVer, no c
|
||||
|
||||
Push to `git.farh.net` only. Never Docker Hub for first-party images.
|
||||
|
||||
## uat→main merge-gate policy
|
||||
|
||||
The uat→main merge-gate policy lives in the `sdlc` skill, not here. The one-line summary: the engineer self-merges a uat→main PR once the four pre-gates (QA, UAT deploy, UAT regression, security) are green and the CEO code review is APPROVED on the Paperclip issue. A CTO Gitea Approve click is reserved for three categories: novel auth / session paths, infra / prod-affecting merges, and risk-flagged merges. See the `sdlc` skill — "uat→main merge-gate policy" — for the full rule, the category list, and the "when uncertain" escalation path.
|
||||
|
||||
## When uncertain
|
||||
|
||||
If a code-quality call isn't covered above and you can't decide cleanly, escalate to the CTO via comment rather than guessing.
|
||||
|
||||
+18
-1
@@ -22,10 +22,27 @@ The following rules apply to every GroomBook agent without exception.
|
||||
|
||||
* **Never `kubectl create secret` in production.** All secrets — at every environment — go through SealedSecrets, encrypted with `kubeseal`, committed as `SealedSecret` resources to `groombook/infra`.
|
||||
|
||||
* **Never bypass the merge gate.** No self-merging PRs. No pushing directly to `dev`, `uat`, or `main`. Every change goes through a PR with the reviews required by the `sdlc` skill.
|
||||
* **Never bypass the merge gate.** No pushing directly to `dev`, `uat`, or `main`. Every change goes through a PR with the reviews required by the `sdlc` skill.
|
||||
|
||||
* **Never run `tofu` directly.** Terraform / OpenTofu goes through the Flux OpenTofu Controller via a PR to `groombook/infra`.
|
||||
|
||||
* **Always read-before-write when updating `adapterConfig.env`.** The Paperclip `PATCH /api/agents/{agentId}` endpoint with an `adapterConfig.env` body **replaces the entire env object** — sending a partial payload silently drops every key you did not include. Before writing any env variable, read the current config first, merge your changes on top, and send the full merged object:
|
||||
|
||||
```bash
|
||||
# 1. Read existing config
|
||||
existing=$(curl -s "$PAPERCLIP_API_URL/api/agents/<agentId>" \
|
||||
-H "Authorization: Bearer $PAPERCLIP_API_KEY")
|
||||
|
||||
# 2. Merge: spread existing env, then apply new keys on top
|
||||
curl -s -X PATCH "$PAPERCLIP_API_URL/api/agents/<agentId>" \
|
||||
-H "Authorization: Bearer $PAPERCLIP_API_KEY" \
|
||||
-H "X-Paperclip-Run-Id: $PAPERCLIP_RUN_ID" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d "$(echo "$existing" | jq '.adapterConfig.env + {"NEW_KEY": {"type":"plain","value":"val"}} | {adapterConfig: {env: .}}')"
|
||||
```
|
||||
|
||||
Skipping the read step is a destructive operation — it erases all existing env vars for that agent.
|
||||
|
||||
## If you are unsure
|
||||
|
||||
If you are unsure whether an action is safe, **stop**. Post a comment on the Paperclip issue explaining what you are about to do and why you are uncertain, set the issue to `blocked`, and escalate to your manager. Do not guess.
|
||||
|
||||
+45
-10
@@ -3,14 +3,17 @@ name: sdlc
|
||||
description: >
|
||||
Software development lifecycle for GroomBook application repos. Covers
|
||||
Gitea authentication, the 3-branch dev/uat/main strategy, the SDLC
|
||||
pipeline phases 1-5, the Stage 1 CI image build, the authentication
|
||||
framework, and application-tool policy. For infrastructure
|
||||
(groombook/infra), see the devops skill.
|
||||
pipeline phases 1-5, the uat→main merge-gate policy (engineer
|
||||
self-merge when pre-gates are green; CTO Gitea Approve only for
|
||||
novel auth, infra/prod-affecting, and risk-flagged merges),
|
||||
the Stage 1 CI image build, the authentication framework, and
|
||||
application-tool policy. For infrastructure (groombook/infra), see
|
||||
the devops skill.
|
||||
---
|
||||
|
||||
# Software Development Lifecycle
|
||||
|
||||
This skill governs **application code repos**. For infrastructure (`groombook/infra`), see the `devops` skill. For PR/test discipline and the `cc @cpfarhood` visibility rule, see `coding-standards`. For non-negotiable safety rules, see `safety`.
|
||||
This skill governs **application code repos**. For infrastructure (`groombook/infra`), see the `devops` skill. For PR/test discipline and the `cc @cpfarhood` visibility rule, see `coding-standards`. For non-negotiable safety rules, see `safety`. The **uat→main merge-gate policy** (which uat→main PRs need a CTO Gitea Approve click vs. engineer self-merge) is defined in this skill — see "uat→main merge-gate policy" below.
|
||||
|
||||
## Gitea authentication
|
||||
|
||||
@@ -26,7 +29,7 @@ Three long-lived branches map to the three deployment environments:
|
||||
|--------|-------------|-----------|-----------|
|
||||
| `dev` | Dev | Engineer | CI passes |
|
||||
| `uat` | UAT | Engineer | QA code review approval |
|
||||
| `main` | Production | Engineer | UAT validation & CTO code review |
|
||||
| `main` | Production | Engineer | UAT validation, security review, and the uat→main merge-gate policy (below) |
|
||||
|
||||
**Engineers always target `dev` first** — never `uat` or `main` directly.
|
||||
- Feature branches: `<agent-name>/<short-description>`.
|
||||
@@ -70,16 +73,48 @@ tea pr create --base dev --title "..." --body "... cc @cpfarhood"
|
||||
|
||||
1. **Engineer** opens a PR from `uat` to `main`.
|
||||
2. **CI** fail → back to **Engineer** (return to Phase 1).
|
||||
3. **CI** pass → **CTO** performs code review.
|
||||
4. **CTO** rejected → back to **Engineer** (return to Phase 1).
|
||||
5. **CTO** approved → **Engineer** merges PR.
|
||||
6. **CI** fail → back to **Engineer** (return to Phase 1).
|
||||
7. **CI** pass → Begin Phase 5.
|
||||
3. **CI** pass → **Engineer** classifies the PR against the **uat→main merge-gate policy** (below):
|
||||
* **In a category that requires CTO Gitea Approve** (novel auth / session paths, infra / prod-affecting merges, `risk:cto-approve` label or explicit CTO/CEO sign-off request) → Engineer pings the CTO for a Gitea Approve click.
|
||||
* **CTO** rejected → back to **Engineer** (return to Phase 1).
|
||||
* **CTO** approved → continue to step 4.
|
||||
* **Outside all three categories** → no CTO click needed; jump to step 4 once the four pre-gates (QA, UAT deploy, UAT regression, security) are green.
|
||||
4. **Engineer** merges the PR.
|
||||
5. **CI** fail → back to **Engineer** (return to Phase 1).
|
||||
6. **CI** pass → Begin Phase 5.
|
||||
|
||||
### Phase 5 — Production Deployment
|
||||
|
||||
The **Engineer** opens a PR against `groombook/infra` to update the relevant Kustomize overlay with the new image tag. From this point the work follows the **`devops` skill pipeline** end-to-end — review, merge, and Flux reconciliation are all owned there. On merge, Flux rolls out the updated pods to production (`https://demo.groombook.dev`).
|
||||
|
||||
## uat→main merge-gate policy
|
||||
|
||||
This is the process policy that governs which `uat → main` PRs need a CTO Gitea Approve click vs. engineer self-merge. It exists because the Gitea `required_approvals` branch-protection gate is satisfied only by a Gitea Approve click — the Paperclip issue-thread QA/UAT-deploy/UAT-regression/security approvals do **not** clear it. The engineer **MUST** classify every `uat → main` PR against this policy before merging.
|
||||
|
||||
### The four pre-gates are unchanged
|
||||
|
||||
A `uat → main` PR is mergeable only when all of these are green on the linked Paperclip issue: QA code review, UAT deploy, UAT regression, and security review. The CTO Gitea Approve click is **in addition to** those four when the PR falls in one of the categories below; it does not replace any of them.
|
||||
|
||||
### Categories that require CTO Gitea Approve
|
||||
|
||||
A CTO Gitea Approve click is required only for PRs in one of the following three categories:
|
||||
|
||||
1. **Novel auth / session paths.** Login, OIDC, OOBE, session middleware, token issuance, password reset, MFA, or any new auth provider integration. Routine changes to auth-gated UI (button styling, error messages, form layout, copy edits) are **not** in this category.
|
||||
2. **Infra / prod-affecting merges.** Deploys, infra manifests, secrets, GitOps overlays, CI/CD, `main` branch protection, prod-affecting routing/ingress, or any change that mutates prod state. **All Phase 5 infra overlay PRs in `groombook/infra` require CTO Gitea Approve without exception.**
|
||||
3. **Risk-flagged merges.** The PR carries the `risk:cto-approve` label, **or** the PR or its linked Paperclip issue thread contains an explicit CTO/CEO sign-off request.
|
||||
|
||||
### Engineer workflow
|
||||
|
||||
The engineer who opened the PR classifies it against the three categories above (escalating to the CTO via comment if the call is unclear), then:
|
||||
|
||||
* **In a category** → request a CTO Gitea Approve click. Engineer merges once the CTO has approved.
|
||||
* **Outside all three categories** → no CTO click needed. Engineer merges once the four pre-gates are green.
|
||||
|
||||
**Board/CEO approval is via SDLC code review (judgment) on the Paperclip issue, not via a Gitea Approve click.** The CEO's role at Phase 4 is to perform the code review on the Paperclip issue thread; that approval satisfies the "CEO approved" pre-condition and is recorded in Paperclip, not in Gitea.
|
||||
|
||||
### When uncertain
|
||||
|
||||
If a `uat → main` PR does not obviously belong to a category, comment on the PR with `@<the-dogfather>` (or escalate to the CEO if the CTO is unavailable) and pause the merge. Do not guess the category — a routine PR is a routine PR, but a borderline PR is cheaper to escalate than to misclassify.
|
||||
|
||||
## Stage 1 CI — Image build
|
||||
|
||||
Triggered automatically on every merge to `main` in an application repo:
|
||||
|
||||
Reference in New Issue
Block a user