generate-config-doc.yml

# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You 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.

name: generate-config-doc
on:
  workflow_call:
    inputs:
      sha:
        type: string
        required: true

permissions: { }

jobs:
  generate-config-doc:
    runs-on: ubuntu-slim
    steps:
      - name: Checkout project
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          persist-credentials: false
          ref: ${{ inputs.sha }}
      
      - name: Set up Python
        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
        with:
          python-version: '3.x'
      
      - name: Download ozone-bin artifact
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
        with:
          name: ozone-bin
          path: ozone-bin
      
      - name: Extract tarball
        run: |
          mkdir -p ozone-bin/extracted
          tar -xzf ozone-bin/ozone-*.tar.gz -C ozone-bin/extracted
      
      - name: Generate configuration documentation
        run: |
          python3 dev-support/ci/xml_to_md.py ozone-bin/extracted Configurations.md
      
      - name: Upload generated documentation
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: config-documentation
          path: Configurations.md
          retention-days: 7