MyST GitHub Pages Deploy #146
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: MyST GitHub Pages Deploy | |
| on: | |
| workflow_dispatch: | |
| schedule: | |
| - cron: '0 0 * * 0' # Run every Sunday @ midnight (UTC) | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| env: | |
| # `BASE_URL` determines the website is served from, including CSS & JS assets | |
| # You may need to change this to `BASE_URL: ''` | |
| BASE_URL: /${{ github.event.repository.name }} | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: 'pages' | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 22.x | |
| - name: Install MyST Markdown | |
| run: | | |
| # npm install -g mystmd | |
| pip install -r requirements.txt | |
| pip install pyosmetrics_pkg/ | |
| pip list | |
| - name: Build HTML Assets | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: myst build --html --execute | |
| shell: bash | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v2 | |
| with: | |
| path: './_build/html' | |
| # Only deploy on pyopensci owned repo / when pushed to main branch | |
| deploy: | |
| needs: build | |
| if: | | |
| github.ref == 'refs/heads/main' && | |
| github.repository_owner == 'pyOpenSci' && | |
| github.event_name == 'push' | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Download artifact | |
| uses: actions/download-artifact@v4 | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v2 |