documentation.yaml

# 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: Check Docs
on:
  - pull_request

jobs:
  docs:
    name: ${{ matrix.doc.name }}
    runs-on: ubuntu-latest
    strategy:
      matrix:
        doc:
          - name: AWS
            dir: aws
            output-file: configurations.md
          - name: AWS SkyWalking Module
            dir: aws/modules/skywalking
            output-file: README.md
      fail-fast:  true
    steps:
      - uses: actions/checkout@v3
        with:
          submodules: true
          ref: ${{ github.event.pull_request.head.ref }}
      - name: Render and check docs is updated
        uses: ./.github/actions/terraform-docs
        with:
          working-dir: ${{ matrix.doc.dir }}
          output-file: ${{ matrix.doc.output-file }}
          output-method: inject
          fail-on-diff: "true"
      - name: Print diff
        if: ${{ failure() }}
        run: git diff --staged