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

Update action to deploy to GitHub pages #623

Merged
merged 11 commits into from
Feb 4, 2025
48 changes: 28 additions & 20 deletions .github/workflows/deploy_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,36 +5,44 @@ on:
branches: [ main ]
pull_request:

permissions:
contents: write

jobs:
build:
build-and-deploy-docs:
runs-on: ubuntu-latest
env:
docs-directory: /home/runner/work/kokkos-core-wiki/kokkos-core-wiki/docs
python-version: '3.10'

steps:
- uses: actions/[email protected]
- uses: actions/[email protected]
- uses: actions/checkout@v3
- name: Set up Python ${{ env.python-version }}
uses: actions/setup-python@v4
with:
python-version: '3.10'
- run: pip install -r build_requirements.txt
python-version: ${{ env.python-version }}
architecture: 'x64'
- name: Install Python dependencies
run: |
pip3 install -r build_requirements.txt
- name: Build documentation
working-directory: ${{ env.docs-directory }}
run: |
make html
- name: Updload documentation as artifact
id: deployment
uses: actions/[email protected]
- name: Archivei documentation
dalg24 marked this conversation as resolved.
Show resolved Hide resolved
uses: actions/upload-artifact@v4
with:
name: documentation.tar.gz
path: ${{ env.docs-directory }}/generated_docs

deploy:
if: ${{ github.ref == 'refs/heads/main' }}
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/[email protected]
# .nojekyll file is needed for GitHub Pages to know it's getting a ready webpage
# and there is no need to generate anything
- name: Generate nojekyll file
working-directory: ${{ env.docs-directory }}/generated_docs
run: touch .nojekyll
# This action moves the content of `generated_docs` to the `deploy-doc-site` branch
- name: Deploy docs
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: deploy-doc-site
folder: ${{ env.docs-directory }}/generated_docs
clean: true
Loading