Skip to content

Bump Redpanda to v24.1.11 (#1398) #24

Bump Redpanda to v24.1.11 (#1398)

Bump Redpanda to v24.1.11 (#1398) #24

# 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@692973e3d937129bcbf40652eb9f2f61becf3332 # tag=v4.1.7
- name: Checkout API Server Repository
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # tag=v4.1.7
with:
repository: DependencyTrack/hyades-apiserver
path: hyades-apiserver
- name: Generate API Server Documentation
uses: jbangdev/jbang-action@9f8c55e0a2b6b297711162b20c209c5e07076e59 # tag=v0.117.1
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/src/main/resources/application.properties
- name: Generate Mirror Service Documentation
uses: jbangdev/jbang-action@9f8c55e0a2b6b297711162b20c209c5e07076e59 # tag=v0.117.1
with:
trust: https://github.com/DependencyTrack/jbang-catalog
script: gen-config-docs@DependencyTrack
scriptargs: >-
--template ./scripts/config-docs.md.peb
--output ./docs/reference/configuration/mirror-service.md
./mirror-service/src/main/resources/application.properties
- name: Generate Repository Metadata Analyzer Documentation
uses: jbangdev/jbang-action@9f8c55e0a2b6b297711162b20c209c5e07076e59 # tag=v0.117.1
with:
trust: https://github.com/DependencyTrack/jbang-catalog
script: gen-config-docs@DependencyTrack
scriptargs: >-
--template ./scripts/config-docs.md.peb
--output ./docs/reference/configuration/repo-meta-analyzer.md
./repository-meta-analyzer/src/main/resources/application.properties
# TODO: Add script invocations for the other services here!
- name: Create Pull Request
uses: peter-evans/create-pull-request@c5a7806660adbe173f04e3e038b0ccdcd758773c # tag=v6.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