Skip to content

Commit

Permalink
Merge pull request #295 from bacpop/gha-docs
Browse files Browse the repository at this point in the history
Use gha to publish docs
  • Loading branch information
johnlees authored Dec 12, 2023
2 parents c6b5a5d + ffd44c3 commit 713caf5
Showing 1 changed file with 19 additions and 22 deletions.
41 changes: 19 additions & 22 deletions .github/workflows/docs_push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,28 +17,25 @@ jobs:
with:
docs-folder: "docs/"

- uses: actions/upload-artifact@v1
- uses: actions/upload-pages-artifact@v2
with:
name: DocumentationHTML
name: github-pages
path: docs/_build/html/
retention-days: 1

# Publish built docs to gh-pages branch.
# ===============================
- name: Commit documentation changes
run: |
git clone https://github.com/bacpop/PopPUNK.git --branch gh-pages --single-branch gh-pages
cp -r docs/_build/html/* gh-pages/
cd gh-pages
git config --local user.email "[email protected]"
git config --local user.name "GitHub Action"
git add .
git commit -m "Update documentation" -a || true
# The above command will fail if no changes were present, so we ignore
# the return code.
- name: Push changes
uses: ad-m/github-push-action@master
with:
branch: gh-pages
directory: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
# ===============================
deploy:
needs: build

permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v3 # or specific "vX.X.X" version tag for this action

0 comments on commit 713caf5

Please sign in to comment.