Skip to content

DEPLOYMENT.md

Latest commit

 

History

History
94 lines (61 loc) · 1.89 KB

DEPLOYMENT.md

File metadata and controls

94 lines (61 loc) · 1.89 KB

Deployment

Process Bus Insight uses a static GitHub Pages landing page stored in docs/ and deployed by .github/workflows/pages.yml.

Required GitHub Pages setting

Use GitHub Actions as the Pages source:

Repository -> Settings -> Pages -> Build and deployment -> Source -> GitHub Actions

Do not use Deploy from a branch for this repository. Branch publishing can leave the site tied to an old branch such as master, which can produce a successful-looking Pages build but still serve a 404 at the public URL after the repository has moved to main.

Required branch setting

The public branch should be:

main

Set it in GitHub:

Repository -> Settings -> Branches -> Default branch -> main

Or with GitHub CLI:

gh repo edit masarray/DigSubAnalyzer --default-branch main --delete-branch-on-merge=true

Deploy manually

After pushing the latest repository content to main, run:

gh workflow run pages.yml --repo masarray/DigSubAnalyzer --ref main

Then check:

gh run list --repo masarray/DigSubAnalyzer --workflow pages.yml --limit 5

Public URL:

https://masarray.github.io/DigSubAnalyzer/

Configure Pages with script

Preview:

.\scripts\configure-github-pages-actions.ps1

Apply:

.\scripts\configure-github-pages-actions.ps1 -Apply

Run diagnosis:

.\scripts\diagnose-github-pages.ps1

How the workflow works

The workflow:

  1. runs on push to main and manual dispatch,
  2. verifies required files under docs/,
  3. uploads docs/ as the GitHub Pages artifact,
  4. deploys the artifact to the github-pages environment.

Because docs/ is uploaded as the artifact root, docs/index.html becomes:

https://masarray.github.io/DigSubAnalyzer/

It is not served as:

https://masarray.github.io/DigSubAnalyzer/docs/