gen_server_virtual_time/.github/workflows/docs.yml at 8105d41ccae7f572473184c9af279bf186226097 · d-led/gen_server_virtual_time · 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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
name: Documentation

on:
  push:
    branches: [main]
    paths:
      - 'docs/**'
      - 'README.md'
      - 'CHANGELOG.md'
      - 'CONTRIBUTING.md'
      - 'LICENSE'
      - 'mix.exs'
      - 'lib/**/*.ex'
      - '.github/workflows/docs.yml'
  pull_request:
    branches: [main]
    paths:
      - 'docs/**'
      - 'README.md'
      - 'CHANGELOG.md'
      - 'CONTRIBUTING.md'
      - 'LICENSE'
      - 'mix.exs'
      - 'lib/**/*.ex'
      - '.github/workflows/docs.yml'

env:
  MIX_ENV: dev
  ELIXIR_VERSION: "1.18"
  OTP_VERSION: "27"

jobs:
  build-docs:
    name: Build Documentation
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Setup Elixir
        uses: erlef/setup-beam@v1
        with:
          elixir-version: ${{ env.ELIXIR_VERSION }}
          otp-version: ${{ env.OTP_VERSION }}

      - name: Cache dependencies
        uses: actions/cache@v4
        with:
          path: |
            deps
            _build
          key: ${{ runner.os }}-mix-docs-${{ hashFiles('**/mix.lock') }}
          restore-keys: |
            ${{ runner.os }}-mix-docs-

      - name: Install dependencies
        run: mix deps.get

      - name: Build documentation
        run: mix docs

      - name: Check for documentation warnings
        run: |
          output=$(mix docs 2>&1)
          echo "$output"
          if echo "$output" | grep -q "warning:.*does not exist"; then
            echo "❌ Documentation has broken links"
            exit 1
          fi
          echo "✅ Documentation builds without warnings"

      - name: Upload documentation
        uses: actions/upload-artifact@v4
        with:
          name: documentation
          path: doc/
          retention-days: 7

      - name: Upload EPUB
        uses: actions/upload-artifact@v4
        with:
          name: documentation-epub
          path: doc/GenServerVirtualTime.epub
          retention-days: 7

  generate-diagrams:
    name: Generate Sequence Diagrams
    runs-on: ubuntu-latest
    if: |
      contains(github.event.head_commit.message, '[diagrams]') ||
      github.event_name == 'pull_request'

    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Setup Elixir
        uses: erlef/setup-beam@v1
        with:
          elixir-version: ${{ env.ELIXIR_VERSION }}
          otp-version: ${{ env.OTP_VERSION }}

      - name: Cache dependencies
        uses: actions/cache@v4
        with:
          path: |
            deps
            _build
          key: ${{ runner.os }}-mix-diagrams-${{ hashFiles('**/mix.lock') }}
          restore-keys: |
            ${{ runner.os }}-mix-diagrams-

      - name: Install dependencies
        run: mix deps.get

      - name: Generate sequence diagrams
        run: mix test --only diagram_generation

      - name: Upload diagrams
        uses: actions/upload-artifact@v4
        with:
          name: sequence-diagrams
          path: generated/examples/*.html
          retention-days: 7

  validate-markdown:
    name: Validate Markdown Links
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Check Markdown links
        uses: gaurav-nelson/github-action-markdown-link-check@v1
        with:
          use-quiet-mode: 'yes'
          use-verbose-mode: 'no'
          config-file: '.github/workflows/markdown-link-check-config.json'
          check-modified-files-only: 'yes'
        continue-on-error: true