update-openapi-docs.yml

# 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 OpenAPI Documentation

on:
  workflow_dispatch: {}

permissions: {}

jobs:
  update-docs:
    name: Update 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 # v6.0.2
      with:
        persist-credentials: false
    - name: Download OpenAPI Specs
      env:
        GH_TOKEN: "${{ github.token }}"
      run: |-
        gh run download --repo DependencyTrack/hyades-apiserver \
          --name openapi-spec \
          --dir /tmp/openapi-spec
    - name: Update Spec Files
      run: |-
        cp /tmp/openapi-spec/v1/openapi.yaml \
          docs/reference/api/openapi-v1.yaml
        cp /tmp/openapi-spec/v2/openapi.yaml \
          docs/reference/api/openapi-v2.yaml
    - name: Create Pull Request
      uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v8.1.1
      with:
        add-paths: "docs/reference/api/openapi-*.yaml"
        branch: update-openapi-docs
        body: "Updates OpenAPI documentation."
        commit-message: Update OpenAPI docs
        delete-branch: true
        labels: documentation
        signoff: true
        title: Update OpenAPI docs