Skip to content

docs: add portable env key lifecycle, rotation and recovery guidance#29

Merged
roodboi merged 4 commits into
mainfrom
codex/define-env-key-rotation-and-recovery-flows-16o779
Mar 24, 2026
Merged

docs: add portable env key lifecycle, rotation and recovery guidance#29
roodboi merged 4 commits into
mainfrom
codex/define-env-key-rotation-and-recovery-flows-16o779

Conversation

@roodboi

@roodboi roodboi commented Mar 24, 2026

Copy link
Copy Markdown
Contributor

Motivation

  • Clarify the portable environment trust and key lifecycle so operators can perform rotations and recovery without accidental secret rewrites.
  • Distinguish distinct operator intents (value rotation, share rotation, recovery/share repair, and project-key rotation) to drive different UX and audit behavior.
  • Document required recovery guardrails and lost-key handling so portability cannot silently escrow or irrevocably lose access.

Description

  • Add a Planned portable key lifecycle flows section to docs/env.md with an operator-goal table and detailed rules for Value rotation, Share rotation, Recovery / share repair, and Project-key rotation.
  • Extend docs/env.md with recovery and lost-key handling guidance, required recovery guardrails, and CLI/UX expectations for each operator flow.
  • Update docs/plans/2026-03-13-env-portability-and-secret-management-design.md to introduce Recovery / share repair as a distinct action, add an operator decision matrix, and expand lost-key handling flows and recovery package expectations.
  • Update the implementation plan in docs/plans/2026-03-13-env-portability-and-secret-management-plan.md to require tests for lost-key vs compromised-key handling and to mandate separate commands and guardrails for the four operator actions.

Testing

  • No automated tests were run as part of this documentation-only change.
  • The updated plan now instructs running bun test --cwd services/auth-broker tests/index.test.ts && bun test tests/env-command.test.ts as the next verification step for the planned implementation.

Codex Task

@changeset-bot

changeset-bot Bot commented Mar 24, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 1dee32d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@roodboi
roodboi merged commit 408f664 into main Mar 24, 2026
2 checks passed
@roodboi
roodboi deleted the codex/define-env-key-rotation-and-recovery-flows-16o779 branch March 24, 2026 02:36
roodboi pushed a commit that referenced this pull request Mar 24, 2026
## <small>1.21.3 (2026-03-24)</small>

* fix(env): support multiline values and project-relative secret paths ([78d0860](78d0860))
* Merge branch 'main' into codex/define-env-key-rotation-and-recovery-flows-16o779 ([1dee32d](1dee32d))
* Merge branch 'main' into codex/define-env-key-rotation-and-recovery-flows-16o779 ([edf8091](edf8091))
* Merge branch 'main' into codex/define-env-key-rotation-and-recovery-flows-16o779 ([401ef6a](401ef6a))
* Merge pull request #29 from hack-dance/codex/define-env-key-rotation-and-recovery-flows-16o779 ([408f664](408f664)), closes [#29](#29)
* docs: clarify portable env recovery flows ([5bb98db](5bb98db))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant