Skip to content
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.

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

Configure github pages #335

Merged
merged 2 commits into from
Jul 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 16 additions & 1 deletion .github/workflows/linux.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ jobs:
- name: Setup
run: |
# -gdwarf-4 - see https://github.com/llvm/llvm-project/issues/56550.
CFLAGS='-gdwarf-4' meson setup build
CFLAGS='-gdwarf-4' meson setup build -Denable-cool-uris=true
env:
CC: ${{ matrix.compiler }}
- name: Build
Expand All @@ -53,3 +53,18 @@ jobs:
name: test logs
path: |
build/meson-logs/
- name: Ensure doxygen version is correct
run: |
doxygen --version > version.txt
echo "1.9.6" >> version.txt
if [ $(sort -V version.txt | tail -n1) != "1.9.6" ]; then
echo "Doxygen version 1.9.6 or earlier expected, see #347"
exit 1
fi
- name: Store doxygen docs for use by the pages workflow
uses: actions/upload-artifact@v3
if: success()
with:
name: doxygen-docs
path: |
build/html/
55 changes: 55 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Deploy to GitHub pages

on:
push:
branches: ["master"]

# Allow running this workflow manually from the Actions tab
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write
Copy link
Member

Choose a reason for hiding this comment

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

I'm curious, which step requires this permission?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

🤷 This is copied from the example workflows github provides and they all have that section as-is. I'm not 100% why the id-token needs to be set to write and documentation on it is a bit sparse.


# Allow only one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
deploy:
runs-on: ubuntu-22.04
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Set up directory tree
run: mkdir -p public_html/doc/
- name: Download doxygen from Linux build
uses: dawidd6/action-download-artifact@v2
with:
workflow: linux.yml
workflow_conclusion: success
name: doxygen-docs
path: doxygen/
- name: Move doxygen to target directory
run: mv doxygen/ public_html/doc/current/
- name: Check out the static website
uses: actions/checkout@v3
with:
repository: xkbcommon/website
persist-credentials: false
path: website
- name: Move static website to target directory
run: mv website/* public_html/
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload pages artifact
uses: actions/upload-pages-artifact@v1
with:
path: public_html/
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2