Skip to content

Commit

Permalink
Update action to deploy to GitHub pages (#623)
Browse files Browse the repository at this point in the history
* Update action to deploy to GitHub pages

This is an attempt to fix the permissions error on the last merge.
The code is inspired from https://github.com/actions/upload-pages-artifact

* Revert "Update action to deploy to GitHub pages"

This reverts commit 93756e1.

* Grant more permissions

* Try setting permissions on the job level

* Update action to deploy to GitHub pages

This is an attempt to fix the permissions error on the last merge.
The code is inspired from https://github.com/actions/upload-pages-artifact

* Combine

* Set permissions

* Fix

* Fix artifact name

* set contents read

* Only run on merge commits

---------

Co-authored-by: Daniel Arndt <[email protected]>
  • Loading branch information
dalg24 and masterleinad authored Feb 4, 2025
1 parent 733285e commit fa6ddd1
Showing 1 changed file with 25 additions and 27 deletions.
52 changes: 25 additions & 27 deletions .github/workflows/deploy_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,41 +6,39 @@ on:
pull_request:

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

steps:
- uses: actions/checkout@v3
- name: Set up Python ${{ env.python-version }}
uses: actions/setup-python@v4
- uses: actions/[email protected]
- uses: actions/[email protected]
with:
python-version: ${{ env.python-version }}
architecture: 'x64'
- name: Install Python dependencies
run: |
pip3 install -r build_requirements.txt
python-version: '3.10'
- run: pip install -r build_requirements.txt
- name: Build documentation
working-directory: ${{ env.docs-directory }}
run: |
make html
- name: Archive documentation
uses: actions/upload-artifact@v4
- name: Updload documentation as artifact
id: deployment
uses: actions/[email protected]
with:
name: documentation.tar.gz
name: github-pages
path: ${{ env.docs-directory }}/generated_docs
# .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
if: ${{ github.ref == 'refs/heads/main' }}
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: deploy-doc-site
folder: ${{ env.docs-directory }}/generated_docs
clean: true

deploy:
if: ${{ github.ref == 'refs/heads/main' }}
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
permissions:
contents: read
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/[email protected]

0 comments on commit fa6ddd1

Please sign in to comment.