Skip to content

Commit

Permalink
Use deploy-pages GitHub Action to build and deploy doxygen doc
Browse files Browse the repository at this point in the history
  • Loading branch information
SimeonEhrig authored and psychocoderHPC committed Jan 9, 2025
1 parent 2ca7904 commit 21ed046
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 91 deletions.
49 changes: 28 additions & 21 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,35 @@

name: Publish documentation to gh-pages

on:
push:
branches:
- develop
env:
ALPAKA_CI_OS_NAME: "Linux"
on: [push, pull_request]

jobs:
gh-pages:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Install doxygen
run: |
cd ${GITHUB_WORKSPACE}
./script/install_doxygen.sh
- name: Run doxygen
run: |
cd ${GITHUB_WORKSPACE}
./script/run_doxygen.sh ${{ github.repository }} ${{ secrets.github_token }}
- name: Publish documentation
run: |
cd ${GITHUB_WORKSPACE}
./script/push_doc.sh
- uses: actions/checkout@v4
- name: Build Doxygen Documentation
uses: mattnotmitt/[email protected]
with:
working-directory: docs
- name: Upload HTML output as artifact
id: deployment
uses: actions/upload-pages-artifact@v3
with:
path: docs/doxygen/html

deploy:
if: github.ref == 'refs/heads/develop' && github.repository_owner == 'alpaka-group'
permissions:
contents: read
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
2 changes: 2 additions & 0 deletions .github/workflows/single-header.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ jobs:
run: |
./script/create-single-header.sh
- name: commit
# run deployment only on the develop branch in the upstream repository
if: github.ref == 'refs/heads/develop' && github.repository_owner == 'alpaka-group'
run: |
set -x
cd single-header
Expand Down
13 changes: 0 additions & 13 deletions script/install_doxygen.sh

This file was deleted.

24 changes: 0 additions & 24 deletions script/push_doc.sh

This file was deleted.

33 changes: 0 additions & 33 deletions script/run_doxygen.sh

This file was deleted.

0 comments on commit 21ed046

Please sign in to comment.