Skip to content

docs: document all eight changes since v0.1.0, and cut 0.1.1 - #32

Merged
ehtishammubarik merged 1 commit into
masterfrom
release/0.1.1
Sep 4, 2026
Merged

ehtishammubarik merged 1 commit into
masterfrom
release/0.1.1

Conversation

@ehtishammubarik

Copy link
Copy Markdown
Owner

Release documentation for 0.1.1. No code changes; pyproject.toml version bump only.

The gap

$ git log --oneline v0.1.0..master
7cc1a97 outputs, never one that reaches the password (#29)      documented as [#9]
d96b41e roadmap and vision, CI-enforced stack count (#28)        NOT documented
23d273e replace stale test figures with a gate (#20)             NOT documented
87215d1 say which stacks are stubs (#19)                          documented as [#10]
e827fcc contributing guide (#18)                                  NOT documented
fb4c46d configure the provider explicitly (#15)                   documented as [#8]
ab6c7fb make the generated repository applyable (#13)             documented (Fixed)
610feaf warn when prod is configured like dev (#6)                NOT documented

Four of eight. The four omitted are the ones that matter most to someone deciding whether to contribute: the guide, the roadmap, and the guardrail check.

The stale figures, which are the more interesting half

Unreleased said "Twelve tests" and "64 resources to add, 0 to change, 0 to destroy". The suite is 91.

This is #17 recurring. #20 removed exactly these numbers from the README, for the stated reason that "rewriting the numbers would only reset the clock; they drifted because nothing kept them true", and replaced them with a CI-enforced coverage floor. The changelog was not in scope for that change and drifted identically.

The distinction this PR draws: a number in a released entry is a dated snapshot and may stand. A number in Unreleased is not yet history, and was simply wrong. So the counts are gone and what replaces them is the gate:

  • coverage floor of 88% on 3.10, 3.11, 3.12
  • the release workflow re-runs the suite against the installed wheel
  • it then asserts on the published artifact that guardrails still refuse an 0.0.0.0/0 database, and that generated output contains no literal credential

One claim I wrote and then had to remove

My first draft said the release workflow "runs a real terraform plan before publishing". It does not:

$ grep -c "terraform plan" .github/workflows/*.yml
ci.yml:0
release.yml:0

The eks + rds plan was run by hand. The changelog now says that outright, since a figure from a manual run is precisely the kind of number the same entry declines to quote. Automating it is #31, filed with three credential-free options and an acceptance criterion that requires reverting the #12 fix and watching the new job go red.

That gap is worth stating plainly: four of the five defects fixed in this release were apply-breaking, terraform validate was green for all four, and nothing in CI would catch the fifth.

Verification

pytest -q                       91 passed
coverage                        90.90%, floor 88 met
secret-scan                     PASS
git-hygiene                     PASS
grep -c "—\|–" CHANGELOG.md     0

Closes #30

🤖 Generated with Claude Code

https://claude.ai/code/session_012fMM2HhoJ2XzDkfMR2HwSa

The Unreleased section described four of the eight commits merged since the
tag. The four it omitted are the ones a prospective contributor most needs:
there is now a contributing guide, a roadmap, and a production guardrail
check, and the changelog said none of that existed.

- Opened a real `## [0.1.1]` heading and bumped pyproject to match, so the
  version the changelog releases and the version the wheel carries agree.
- Added the missing entries: production intent guardrails (#5, #6), the
  contributing guide (#18), the roadmap with its CI-enforced stack count
  (#28), and the removal of the stale README test figures (#17, #20).
- Removed "Twelve tests" and "64 resources to add" from Unreleased. That is
  #20 recurring in the one file that change did not cover. A number in a
  released entry is a dated snapshot and may stand; a number in Unreleased is
  not yet history and was simply wrong.
- Replaced them with the gates that are actually enforced: the 88% coverage
  floor on 3.10/3.11/3.12, and the release workflow asserting on the published
  artifact that guardrails still refuse an 0.0.0.0/0 database and that the
  generated output carries no literal credential.
- Stated plainly that there is no `terraform plan` in the release workflow.
  The eks+rds plan was run by hand, and a figure from a manual run is exactly
  what this entry declines to quote. Filed #31 to automate it.
- ROADMAP: the same 64-resource claim, in the present tense, replaced with
  what CI does verify.

Verified: pytest 91 passed, coverage 90.90% against the 88% floor.

Closes #30

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012fMM2HhoJ2XzDkfMR2HwSa
@ehtishammubarik
ehtishammubarik merged commit ba23132 into master Sep 4, 2026
10 checks passed
@ehtishammubarik
ehtishammubarik deleted the release/0.1.1 branch September 4, 2026 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The Unreleased changelog documents 4 of 8 merged changes, and carries a stale test count

1 participant