build_docs_upload_artifacts.yml

name: Build docs and upload as artifact (develop)
on:
  push:
    branches:
      - 'develop'

jobs:
  build:
    runs-on: ubuntu-22.04

    steps:
      - name: Checkout Repository
        uses: actions/checkout@v4.1.7

      - name: Install Doxygen and Graphviz
        uses: awalsh128/cache-apt-pkgs-action@latest
        with:
          packages: doxygen graphviz
          version: 1.0  # Version of cache to load. Each version will have its own cache.

      - name: Build docs
        uses: threeal/cmake-action@v2.0.0
        with:
          source-dir: ./
          build-dir: build
          options: |
            BUILD_DOCS=ON
            USE_TREZOR_CRYPTO=ON

      - name: Upload HTML docs artifact
        uses: actions/upload-artifact@v4.4.0
        with:
          # Name of the artifact to upload.
          # Optional. Default is 'artifact'
          name: 'libtropic-html-docs'

          # A file, directory or wildcard pattern that describes what to upload
          # Required.
          path: 'build/docs/doxygen/html/'

          # The desired behavior if no files are found using the provided path.
          # Available Options:
          #   warn: Output a warning but do not fail the action
          #   error: Fail the action with an error message
          #   ignore: Do not output any warnings or errors, the action does not fail
          # Optional. Default is 'warn'
          if-no-files-found: 'error'

          # Duration after which artifact will expire in days. 0 means using default retention.
          # Minimum 1 day.
          # Maximum 90 days unless changed from the repository settings page.
          # Optional. Defaults to repository settings.
          retention-days: 0

          # The level of compression for Zlib to be applied to the artifact archive.
          # The value can range from 0 to 9.
          # For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads.
          # Optional. Default is '6'
          compression-level: 0

          # If true, an artifact with a matching name will be deleted before a new one is uploaded.
          # If false, the action will fail if an artifact for the given name already exists.
          # Does not fail if the artifact does not exist.
          # Optional. Default is 'false'
          overwrite: true

          # Whether to include hidden files in the provided path in the artifact
          # The file contents of any hidden files in the path should be validated before
          # enabled this to avoid uploading sensitive information.
          # Optional. Default is 'false'
          include-hidden-files: false