Skip to content

ci: enable GitHub Pages deployments #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
EstandarMustaq merged 5 commits into from
Jul 16, 2026
Merged

ci: enable GitHub Pages deployments #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4afb547
ci: enable GitHub Pages deployments
EstandarMustaq Jul 15, 2026
79dbb1e
ci: register required documentation checks
EstandarMustaq Jul 16, 2026
b80f018
build: pin documentation toolchain
EstandarMustaq Jul 16, 2026
4208adb
fix: keep Pages bootstrap self-contained
EstandarMustaq Jul 16, 2026
91dcf63
fix: harden Pages bootstrap workflow
EstandarMustaq Jul 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/pages-bootstrap/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>MAVULA Developer Docs</title>
</head>
<body></body>
</html>
30 changes: 30 additions & 0 deletions .github/workflows/pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Publish API Reference
on:
workflow_dispatch: {}
Comment thread
EstandarMustaq marked this conversation as resolved.
permissions:
contents: read
concurrency:
group: pages
cancel-in-progress: true
Comment on lines +7 to +8

@chatgpt-codex-connector chatgpt-codex-connector Bot Jul 16, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Keep skipped dispatches out of the deploy concurrency group

Because this is workflow-level concurrency with a constant group, any manual workflow_dispatch run from a non-main ref enters the same pages group before the job-level if: checks skip both jobs. GitHub Actions concurrency cancels in-progress workflow runs in the same group when cancel-in-progress: true, so a skipped feature-branch dispatch by a write user can abort an active production Pages deployment from main; include github.ref in the group or move concurrency to the deploy job after the main gate.

Useful? React with 👍 / 👎.

jobs:
build:
if: github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/upload-pages-artifact@v4
with: { path: .github/pages-bootstrap }
deploy:
if: github.ref == 'refs/heads/main'
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy
id: deployment
uses: actions/deploy-pages@v4
13 changes: 13 additions & 0 deletions .github/workflows/required-ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: Required CI
on:
pull_request: {}
push: { branches: [main] }
permissions: { contents: read }
jobs:
required:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/setup-node@v6
with: { node-version: 22.22.3 }
- run: node scripts/guardian.mjs