specification/.github/workflows/build_docs.yml at master · CycloneDX/specification · 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
name: Build Docs

on:
  push:
    branches: ['master', 'main']
  pull_request:
  workflow_dispatch:

env:
  PYTHON_VERSION_DEFAULT: "3.10"

# https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github_token
permissions: {}

jobs:
  docs_xml:
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: docgen/xml
    steps:
    - name: Checkout
      # see https://github.com/actions/checkout
      uses: actions/checkout@v6
    - name: Set up JDK
      # see https://github.com/actions/setup-java
      uses: actions/setup-java@v5
      with:
        java-version: '21'
        distribution: 'zulu'
        java-package: jdk
    - name: Generate Schema documentation
      run: ./gen.sh
    - name: Archive Schema documentation
      # https://github.com/actions/upload-artifact
      uses: actions/upload-artifact@v6
      with:
        name: XML-Schema-documentation
        path: docgen/xml/docs
        if-no-files-found: error
  docs_json:
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: docgen/json
    steps:
    - name: Checkout
      # see https://github.com/actions/checkout
      uses: actions/checkout@v6
    - name: Setup Python Environment
      # see https://github.com/actions/setup-python
      uses: actions/setup-python@v6
      with:
        python-version: ${{ env.PYTHON_VERSION_DEFAULT }}
        architecture: 'x64'
    - name: Generate Schema documentation
      run: ./gen.sh
    - name: Archive Schema documentation
      # https://github.com/actions/upload-artifact
      uses: actions/upload-artifact@v6
      with:
        name: JSON-Schema-documentation
        path: docgen/json/docs
        if-no-files-found: error
  docs_proto:
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: docgen/proto
    steps:
    - name: Checkout
      # see https://github.com/actions/checkout
      uses: actions/checkout@v6
    - name: Generate Schema documentation
      run: ./gen.sh
    - name: Archive Schema documentation
      # https://github.com/actions/upload-artifact
      uses: actions/upload-artifact@v6
      with:
        name: PROTO-Schema-documentation
        path: docgen/proto/docs
        if-no-files-found: error