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 6c958c3
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 0 deletions.
46 changes: 46 additions & 0 deletions .github/workflows/publish-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Publish documentation

on:
workflow_call:
workflow_dispatch:

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

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

- 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: 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 }}
runs-on: ubuntu-latest
needs: build_docs
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 6c958c3

Please sign in to comment.