Skip to content

Latest commit

 

History

History
122 lines (87 loc) · 4.35 KB

HOSTED-SETUP.md

File metadata and controls

122 lines (87 loc) · 4.35 KB

Hosted repository setup

Status: Executed for the first source publication. Use this file to verify or repair controls. Do not repeat repository creation.

Authority boundary

The owner approved the wip-commit name, github.com/nstranquist/wip-commit module path, and capture-only boundary on 2026-08-16. This approval does not permit an agent to push. The repository instructions assign the first push to a human.

Do not create a release tag until every public-beta gate passes.

The first-publication procedure is now a historical record in PUBLICATION-HANDOFF.md. Current control evidence is in HOSTED-STATUS-2026-08-18.md. This runbook does not authorize a release tag.

Source of truth

Use the current GitHub documentation when this runbook executes:

Review those pages again before the first push. GitHub settings and plan availability can change.

Repository creation

  1. Validate and retain the private pre-first-push receipt.
  2. Follow the human-only first-push and pull-request sequence in the publication handoff.
  3. Verify that remote main equals the receipt's candidate commit and tree.
  4. Set main as the default branch before you activate its ruleset.

Do not force-push or replace imported history.

Main branch ruleset

Create one active branch ruleset for main. Do not grant a routine bypass.

Require:

  • pull requests before updates.
  • at least one approval.
  • dismissal of stale approvals after new commits.
  • resolution of review conversations.
  • required status checks.
  • linear history.
  • blocked force pushes.
  • blocked branch deletion.

Run the first pull request before you select status-check names. Use the exact check names that GitHub reports for:

  • Linux, macOS, and Windows tests.
  • the race job.
  • golangci-lint.
  • dependency review.

Set the ruleset to active only after its target and required checks are exact.

Security settings

Enable and verify:

  • the dependency graph.
  • Dependabot alerts.
  • Dependabot security updates.
  • secret scanning for the public repository.
  • push protection when the repository plan provides it.
  • private vulnerability reporting.
  • security-alert notifications for the maintainer.

The repository already contains SECURITY.md. Verify that GitHub displays it on the repository security page.

Actions settings

Use read-only workflow permissions by default. Grant write permissions only in the release job that needs them.

Keep every third-party action pinned to a complete commit ID. Verify that the workflow does not persist checkout credentials.

Require approval before an untrusted fork workflow receives protected access.

Release verification

After the approved prerelease workflow runs:

  1. Download every archive, checksum file, and release receipt.
  2. Verify checksums.txt in a clean directory.
  3. Run gh attestation verify for each release archive.
  4. Verify that the attestation names the approved repository and tag commit.
  5. Install the tagged module in a clean environment.
  6. Run wip version.
  7. Record the workflow URL and redacted verification receipt.

An attestation has value only after a consumer verifies it.

Evidence to retain

Keep these public or redacted records:

  • owner approval for the name and module path.
  • candidate commit and tree IDs.
  • ruleset URL or exported settings.
  • hosted job URLs for all required platforms.
  • enabled security-setting receipt.
  • private reporting test receipt.
  • release checksums and attestations.
  • clean installation receipt.
  • unresolved gaps and their owners.

Do not store access tokens, notification addresses, private reports, or raw security logs in the repository.