Skip to content

Commit

Permalink
Add GH Actions workflow to publish docs to GH Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
kdkasad committed Apr 21, 2024
1 parent 8057c99 commit b25f3f7
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 0 deletions.
61 changes: 61 additions & 0 deletions .github/workflows/publish-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: Publish documentation

on:
workflow_call:
workflow_dispatch:

concurrency:
group: ${{ github.workflow }}
cancel-in-progress: true

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


jobs:
build_docs:
name: Build documentation
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v4

- name: Configure GitHub Pages
uses: actions/configure-pages@v5

- name: Set up Rust toolchain
uses: dtolnay/rust-toolchain@stable

- name: Cache build artifacts
uses: Swatinem/rust-cache@v2

- name: Build documentation
run: cargo doc --workspace --release

- name: Remove lock file
run: rm -f ./target/doc/.lock

- name: Create index.html file
run: echo '<meta http-equiv="refresh" content="0;url=numbrs/index.html">' > ./target/doc/index.html

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./target/doc

deploy_docs:
name: Deploy documentation site

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

needs: build_docs

runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
4 changes: 4 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ jobs:
name: Build
uses: ./.github/workflows/build.yml

publish_docs:
name: Publish documentation
uses: ./.github/workflows/publish-docs.yml

publish-binaries:
name: Upload Numbrs binaries to GitHub release
if: ${{ github.event_name == 'release' }}
Expand Down

0 comments on commit b25f3f7

Please sign in to comment.