validator/.github/workflows/docs.yml at 98590bcfd65e7db8942aca7eb762d959d3ad024c · space-code/validator · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
name: Deploy DocC Documentation

on:
  push:
    branches: ["main"]
  workflow_dispatch:
    inputs:
      version:
        description: 'Documentation version'
        required: false
        default: latest'

permissions:
  contents: write

concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  deploy:
    runs-on: macos-15
    steps:
      - name: Checkout
        uses: actions/checkout@v6

      - name: Setup Xcode
        uses: maxim-lobanov/setup-xcode@v1
        with:
          xcode-version: latest-stable

      - name: Get Version
        id: version
        run: |
          if [ -n "${{ github.event.inputs.version }}" ]; then
            VERSION="${{ github.event.inputs.version }}"
          else
            VERSION="latest"
          fi
          echo "VERSION=$VERSION" >> $GITHUB_OUTPUT
          echo "Building documentation for version: $VERSION"

      - name: Build DocC
        id: build
        uses: space-code/build-docc@main
        with:
          schemes: '["ValidatorCore", "ValidatorUI"]'
          version: ${{ steps.version.outputs.version }}

      - name: Generate Index Page
        uses: space-code/generate-index@v1.0.0
        with:
          version: ${{ steps.version.outputs.version }}
          project-name: 'Validator'
          project-description: 'Validator is a modern, lightweight Swift framework that provides elegant and type-safe input validation.'
          modules: |
            [
              {
                "name": "ValidatorCore",
                "path": "validatorcore",
                "description": "Core validation functionality and rules for Swift applications. Contains base types, protocols, and validator implementations.",
                "badge": "Core Module"
              },
              {
                "name": "ValidatorUI",
                "path": "validatorui",
                "description": "UI components and helpers for building validation interfaces. Ready-to-use solutions for SwiftUI and UIKit.",
                "badge": "UI Module"
              }
            ]

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs