hyades/.github/workflows/update-config-docs.yml at main · DependencyTrack/hyades · 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
# This file is part of Dependency-Track.
#
# 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.
#
# SPDX-License-Identifier: Apache-2.0
# Copyright (c) OWASP Foundation. All Rights Reserved.
name: Update Config Documentation

on:
  push:
    branches:
    - main
    paths:
    - ".github/workflows/update-config-docs.yml"
    - "scripts/config-docs.md.peb"
    - "*/src/main/resources/application.properties"
  workflow_dispatch: { }

permissions: { }

jobs:
  generate-docs:
    name: Generate Documentation
    runs-on: ubuntu-latest
    timeout-minutes: 5
    permissions:
      contents: write
      pull-requests: write
    if: "${{ github.repository_owner == 'DependencyTrack' }}"
    steps:
    - name: Checkout Repository
      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # tag=v6.0.2
    - name: Checkout API Server Repository
      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # tag=v6.0.2
      with:
        repository: DependencyTrack/hyades-apiserver
        path: hyades-apiserver
    - name: Generate API Server Documentation
      uses: jbangdev/jbang-action@7b0e42ecace72f0a0df37a1574c8c57b0d5a77aa # tag=v0.137.0
      with:
        trust: https://github.com/DependencyTrack/jbang-catalog
        script: gen-config-docs@DependencyTrack
        scriptargs: >-
          --template ./scripts/config-docs.md.peb
          --output ./docs/reference/configuration/api-server.md
          ./hyades-apiserver/apiserver/src/main/resources/application.properties
    - name: Create Pull Request
      uses: peter-evans/create-pull-request@c0f553fe549906ede9cf27b5156039d195d2ece0 # tag=v8.1.0
      with:
        add-paths: "docs/reference/configuration/*.md"
        branch: update-config-docs
        body: "Updates configuration documentation."
        commit-message: Update config docs
        delete-branch: true
        labels: documentation
        signoff: true
        title: Update config docs