example.yml

name: Example
on:
  workflow_dispatch:
jobs:
  docpkg:
    runs-on: ubuntu-latest
    steps:
      - name: Check out current branch and docpkg branches
        uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: Cache Cargo home containing Documentation Packager source and binary
        uses: actions/cache@v3
        with:
          path: |
            ~/.cargo/bin/
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
      - name: Configure Git user
        run: |
          git config --global user.name "github-actions[bot]"
          git config --global user.email "github-actions[bot]@users.noreply.github.com"
      - name: Install Documentation Packager
        run: cargo install --git https://github.com/sander/docpkg --rev $docpkg_revision
        env:
          docpkg_revision: 1628fd9b74fb8e90604df8d49e2ee4978317ddc0
        continue-on-error: true # An error usually means that docpkg was already installed
      - name: Publish documentation package
        run: docpkg publish $source_root
        env:
          source_root: resources/test/example
          BRANCH_NAME: ${{ github.head_ref || github.ref_name }}