Deploy Jekyll with GitHub Pages dependencies preinstalled #110
This file contains hidden or 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
| # Sample workflow for building and deploying a Jekyll site to GitHub Pages | |
| name: Deploy Jekyll with GitHub Pages dependencies preinstalled | |
| on: | |
| # Runs on pushes targeting the default branch | |
| push: | |
| branches: ["main"] | |
| # Runs after new MicroPython release is downloaded | |
| workflow_run: | |
| workflows: ["Download MicroPython Release Binaries"] | |
| types: | |
| - completed | |
| # Allows this workflow to be run manually from the Actions tab | |
| workflow_dispatch: | |
| # 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 job | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| - name: Get git commit hash for inclusion in the site | |
| run: tools/getCommitHash.sh | |
| - name: Set Variables | |
| run: | | |
| INC_VER=$(cat _includes/mpVersion.txt) | |
| echo "VERSION=$INC_VER" >> $GITHUB_ENV | |
| INC_DATE=$(cat _includes/mpDate.txt) | |
| echo "DATE=$INC_DATE" >> $GITHUB_ENV | |
| - name: Edit MP Version and Date into Manifests | |
| # It looks sketchy to edit files checked out of the repo, but the changes won't be committed | |
| run: | | |
| for file in manifest*.json; do | |
| sed -i -e "s/mpVersion/$VERSION/g" -e "s/mpDate/$DATE/g" "$file" | |
| done | |
| - name: Build with Jekyll | |
| uses: actions/jekyll-build-pages@v1 | |
| with: | |
| source: ./ | |
| destination: ./_site | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| # Deployment job | |
| deploy: | |
| 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 |