Skip to content

DEPLOYMENT.md

Latest commit

 

History

History
19 lines (13 loc) · 1.5 KB

DEPLOYMENT.md

File metadata and controls

19 lines (13 loc) · 1.5 KB
Raw

GitHub Pages deployment

The workflow in .github/workflows/pages.yml validates pull requests and deploys only from main or a manual dispatch. It checks out both repositories, runs the credential-free canonical and site gates, assembles _site, verifies agentctl/index.html, and uses GitHub's current Pages artifact deployment actions.

Required repository settings after merge

  1. Open the opensourceops/opensourceops.github.io repository settings.
  2. Under Pages, set Source to GitHub Actions.
  3. Keep the public custom domain empty unless OpenSourceOps intentionally adds one later.
  4. Under Actions, allow GitHub-owned actions. No provider secret is required.
  5. Protect main according to the organization's normal policy and require the validate job if desired.
  6. Run the workflow manually once, or merge a validated change to main.
  7. Confirm the deployment environment reports https://opensourceops.github.io/ and verify https://opensourceops.github.io/agentctl/ separately.

Do not configure Pages to deploy from a branch directory. The workflow uploads the complete _site artifact, including the organization root, .nojekyll, and the agentctl/ subdirectory.

Security model

Pull requests receive read-only repository permission and never reach the deployment job. The deployment job alone receives pages: write and id-token: write. The workflow does not read provider credentials or repository secrets. All action references are immutable commit SHAs with release annotations.