Add task to build documentation

This commit is contained in:
Anthony Oteri
2023-09-29 11:58:24 -04:00
parent b8d64542f2
commit a47b4369f8
+44
View File
@@ -25,6 +25,50 @@ jobs:
draft: false draft: false
prerelease: false prerelease: false
build-docs:
name: Build documentation
needs: create_release
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Install Rust Toolchain
uses: dtolnay/rust-toolchain@stable
with:
toolchain: stable
components: rustdoc
- name: Cache build dependencies
uses: Swatinem/rust-cache@v2
- name: Run cargo doc
run:
cargo doc
--bin=dredge
--no-deps
--all-features
--document-private-items
--release
- name: Archive the Docs
run:
tar --directory target/doc -czf
dredge-$(( github.ref_name))-docs.tar.gz
dredge
- name: Upload documentation assets
uses: actions/upload-release-asset@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
upload_url: ${{ needs.create_release.outputs.upload_url }}
asset_name: dredge-${{ github.ref_name }}-docs.tar.gz
asset_path: dredge-${{ github.ref_name }}-docs.tar.gz
asset_content_type: application/gzip
release_assets: release_assets:
name: Release assets name: Release assets
needs: create_release needs: create_release