Documentation #3
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: Documentation | |
on: | |
workflow_dispatch: | |
env: | |
CARGO_TERM_COLOR: always | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: esp-rs/[email protected] | |
with: | |
default: true | |
ldproxy: false | |
- name: Build documentation | |
run: ./.github/scripts/build_docs.sh | |
# https://github.com/actions/deploy-pages/issues/303#issuecomment-1951207879 | |
- name: Remove problematic '.lock' files | |
run: find docs -name ".lock" -exec rm -f {} \; | |
- name: Upload Pages artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: "docs" | |
deploy: | |
# Add a dependency to the build job: | |
needs: build | |
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment: | |
permissions: | |
pages: write # to deploy to Pages | |
id-token: write # to verify the deployment originates from an appropriate source | |
# Deploy to the github-pages environment: | |
environment: | |
name: github-pages | |
url: ${{ steps.change-page-url.outputs.new_page_url }} | |
# Specify runner + deployment step: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 | |
# Work around the fact that the path cannot be specified with deploy-pages | |
# https://github.com/orgs/community/discussions/37267#discussioncomment-4012060 | |
- name: Override page_url | |
id: change-page-url | |
run: echo "new_page_url=${{ steps.deployment.outputs.page_url }}esp-hal/" >> $GITHUB_OUTPUT |