documentation.yml

# Build and deploy DocC to GitHub pages. Based off of @karwa's and @stephencelis work here:
# https://github.com/karwa/swift-url/blob/main/.github/workflows/docs.yml
# https://github.com/pointfreeco/swift-composable-architecture/blob/main/.github/workflows/documentation.yml
#
# swift-url (WebURL)
# Copyright Karl Wagner, and the swift-url Contributors.
#
# Copyright 2023 Tinkoff Bank
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# 
# What's changed:
#
# - Project name changed TinkoffConcurrency
# - Documentation generation is called with DOCC_JSON_PRETTYPRINT="YES" to simplify git diffing
#
   
name: Documentation

on:
  release:
    types:
      - published
  push:
    branches:
      - main
  workflow_dispatch:

permissions:
  contents: write

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

jobs:
  build:
    runs-on: macos-12
    steps:
      - name: Select Xcode 14.1
        run: sudo xcode-select -s /Applications/Xcode_14.1.app

      - name: Checkout Package
        uses: actions/checkout@v2
        with:
          fetch-depth: 0

      - name: Checkout gh-pages Branch
        uses: actions/checkout@v2
        with:
          ref: gh-pages
          path: docs-out

      - name: Build documentation
        run: >
          rm -rf docs-out/.git;
          rm -rf docs-out/main;
          git tag -l --sort=-v:refname | grep -e "\d\+\.\d\+.0" | tail -n +6 | xargs -I {} rm -rf {};

          for tag in $(echo "main"; git tag -l --sort=-v:refname | grep -e "\d\+\.\d\+.0" | head -6);
          do
            if [ -d "docs-out/$tag/data/documentation/tinkoffconcurrency" ] 
            then 
              echo "✅ Documentation for "$tag" already exists.";
            else 
              echo "⏳ Generating documentation for TinkoffConcurrency @ "$tag" release.";
              rm -rf "docs-out/$tag";

              git checkout .;
              git checkout "$tag";

              DOCC_JSON_PRETTYPRINT="YES" swift package \
                --allow-writing-to-directory docs-out/"$tag" \
                generate-documentation \
                --target TinkoffConcurrency \
                --output-path docs-out/"$tag" \
                --transform-for-static-hosting \
                --hosting-base-path /TinkoffConcurrency/"$tag" \
                && echo "✅ Documentation generated for TinkoffConcurrency @ "$tag" release." \
                || echo "⚠️ Documentation skipped for TinkoffConcurrency @ "$tag".";
            fi;
          done

      - name: Fix permissions
        run: 'sudo chown -R $USER docs-out'

      - name: Publish documentation to GitHub Pages
        uses: JamesIves/github-pages-deploy-action@4.1.7
        with:
          branch: gh-pages
          folder: docs-out
          single-commit: true