adam/engineering-handbook
1
0
Fork 0
mirror of https://github.com/Sea-Haven-Industries/engineering-handbook.git synced 2026-09-30 06:53:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(hcp): require VCS triggers to cover Lambda source paths (PLAT-183) (#45)
Some checks failed
ci / ci / ci (push) Has been cancelled
Details

Browse source
This commit is contained in:
Adam Moussa 2026-09-10 21:00:30 +00:00 • committed by GitHub
parent f57ac2c135
commit aea86c0f5c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -17,7 +17,7 @@ Engineering conventions and best practices for Sea Haven Industries.
- [Code Review](code-review.md) -- what to look for, giving feedback, turnaround expectations
- [Code Review Rubric](code-review-rubric.md) -- BLOCK/FIX/NIT/QUESTION finding categories and output format
- [GitHub Standards](github-standards.md) -- branch defaults, repo hygiene, Dependabot
- [AWS Infrastructure](aws-infrastructure.md) -- SAM vs CDK, Lambda defaults, CloudFormation
- [AWS Infrastructure](aws-infrastructure.md) -- SAM vs CDK, HCP VCS file triggers, Lambda defaults, CloudFormation
- [SAM Project Layout](sam-project-layout.md) -- standard directory structure for serverless projects
- [CDK Project Layout](cdk-project-layout.md) -- standard directory structure for CDK projects
- [Lambda Starter Template](lambda-template.md) -- minimal SAM scaffold for a new Python Lambda

10
aws-infrastructure.md
View file

@ -8,6 +8,16 @@
- Every deployed resource should be managed by IaC (CloudFormation via SAM/CDK, or HCP Terraform state for migrated stacks)
- No manually-created Lambdas, roles, or other resources outside of IaC
## HCP Terraform VCS file triggers
New prod/dev HCP workspaces follow the first-apply runbook in `seahaven-org-baseline`. When the workspace is created, set VCS file triggers before the first merge to the tracked branch.
- Keep `file-triggers-enabled`. Do not turn file triggers off so that docs-only commits skip prod applies.
- `trigger-prefixes` are added to the working directory. `trigger-patterns` replace the working-directory filter and must include a glob for that directory.
- If the plan reads files outside the working directory (Lambda source, layers, `requirements.txt`, build scripts that copy `src/`, `functions/`, `lambda/`, or `lambdas/`), list those paths in `trigger-prefixes` or `trigger-patterns`. An empty pair with `working-directory=terraform` queues runs only for `terraform/` changes, so a source-only merge is ingested and then silently skipped.
- Record the live prefixes or patterns in the app README next to the workspace name.
- `python3 scripts/check_hcp_workspace_triggers.py` in `seahaven-org-baseline` lists file-triggered workspaces in `seahaven-mgmt`, `seahaven-prod`, and `seahaven-dev` and flags an empty prefix/pattern pair when the repo working directory references those source trees.
## Lambda Defaults
These apply to every Lambda in every project. Verify, don't assume.