Skip to content

docs(repo): mark the Free-plan environment split as observed, cite GitHub Docs - #124

Open
marcusjacobson wants to merge 2 commits into
mainfrom
docs/github-free-env-availability-provenance
Open

docs(repo): mark the Free-plan environment split as observed, cite GitHub Docs#124
marcusjacobson wants to merge 2 commits into
mainfrom
docs/github-free-env-availability-provenance

Conversation

@marcusjacobson

Copy link
Copy Markdown
Owner

Summary

Docs plane: correct the provenance of the GitHub Free-plan environment note in Getting started §2 — the deployment-branch-policy availability on Free private repos is empirically observed behavior, not something GitHub's documentation guarantees — and add the missing citation. Post-merge follow-up from the PR #123 downstream verification (the operations repo's empirical finding).

Plane and scope

  • infra/** (control plane, Bicep)
  • data-plane/** (data plane, YAML)
  • scripts/** (data-plane apply logic)
  • .github/workflows/** (CI/CD)
  • docs/** or README.md (documentation)

Also index.html (regenerated embeds — required whenever an embedded doc changes) and CHANGELOG.md. Single plane: docs only.

Change detail

  • Reword the > [!NOTE] GitHub-plan block in docs/getting-started.md §2: the claim "deployment branch policies work on all plans" becomes an explicitly observed result (REST accepted deployment_branch_policy on a GitHub Free private repo, verified 2026-07-16; required reviewers rejected with HTTP 422), contrasted with what GitHub actually documents — "Users with GitHub Free plans can only configure environments for public repositories" and "Some features for environments have no or limited availability for private repositories", with no per-feature breakdown as of 2026-07-16 (Managing environments for deployment). Interim-posture guidance (branch policy + per-environment OIDC subject per ADR 0010 §3) unchanged.
  • Regenerate index.html embedded doc snapshots (Update-LandingPageEmbeds.ps1; -Check passes).
  • CHANGELOG entry under 2026-07-16 → Documentation.

Validation evidence

Update-LandingPageEmbeds.ps1 -Check → Embedded docs are current (5 docs), exit 0
WebFetch of the cited GitHub Docs page (2026-07-16) confirms the quoted availability wording;
the page does NOT document the per-feature Free-private split — which is exactly why the note
now labels it as observed behavior.
Doc-only change: bicep/yaml/powershell/pester gates unaffected (validate runs on the PR).

Security review

  • No secrets, keys, tokens, or real tenant/subscription/object IDs in the diff
  • No new identities
  • No publicNetworkAccess changes
  • No role-assignment changes

Rollback plan

Revert the single docs commit(s); no state, workflow, or script behavior is touched.

Breaking / destructive

None — prose-only.

🤖 Generated with Claude Code

…tHub Docs

The GitHub-plan note in getting-started section 2 stated 'deployment
branch policies work on all plans' as bare fact. GitHub's own
availability notes say something narrower — Free plans 'can only
configure environments for public repositories', with no per-feature
breakdown — so the branch-policy half is empirically observed behavior
(REST accepted deployment_branch_policy on a Free private repo,
2026-07-16) that the documentation does not guarantee. Reworded the
note to separate observed from documented and added the citation with
its as-of date, per the grounding rule that capability claims cite the
authoritative page. Interim posture guidance unchanged. index.html
embeds regenerated.

See: https://docs.github.com/en/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@marcusjacobson marcusjacobson added the needs-review Awaiting lab-owner review label Jul 16, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Owner Gate

Ready for lab-owner approval. All checks are passing and this PR carries needs-review.

To approve, run @owner-approval in Copilot Chat, or run:

gh pr edit 124 --add-label owner-approved

This comment is maintained automatically by the pr-owner-gate workflow. It updates on every push and label change. Re-toggle the needs-review label to refresh after a check completes.

1 similar comment
@github-actions

Copy link
Copy Markdown
Contributor

Owner Gate

Ready for lab-owner approval. All checks are passing and this PR carries needs-review.

To approve, run @owner-approval in Copilot Chat, or run:

gh pr edit 124 --add-label owner-approved

This comment is maintained automatically by the pr-owner-gate workflow. It updates on every push and label change. Re-toggle the needs-review label to refresh after a check completes.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
marcusjacobson added a commit that referenced this pull request Aug 17, 2026
The first push of this batch put the #124 assertions in this file, but they
read scripts/Get-UpstreamDelta.ps1 -- operator tooling that the template does
not carry -- so the suite died in BeforeAll here with `Cannot find path`.
Downstream every test passed, because downstream the file exists; the failure
only existed in this repo.

Those assertions now live in the operations repo's own suppressed suite. This
file is purely about the two workflows, both of which exist here, and its
header no longer claims the assertion it lost.

Re-copied from operations lab 9aee58b. ADR 0055 identifier residual scan
re-run in this clone: 436 files, 0 unclaimed, 0 quarantined.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-review Awaiting lab-owner review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant