build-module-readme.yml

# .github/workflows/build-module-readme.yml

# Copyright 2023 Google LLC
#
# 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
#
#     https://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: 'BUILD - Module README.md'

on:
  push:
    branches:
      - main
    paths:
      - 'modules/**/variables.tf'
      - 'modules/**/outputs.tf'
  workflow_dispatch:
permissions:
  contents: write

jobs:
  build:
    name: 'Module README Variables/Outputs'
    runs-on: ubuntu-latest
    env:
      WORKFLOW_EMAIL: ${{ secrets.WORKFLOW_EMAIL }}
      WORKFLOW_USERNAME: ${{ secrets.WORKFLOW_USERNAME }}
      WORKFLOW_PAT: ${{ secrets.WORKFLOW_PAT }}

    steps:
      - name: Checkout
        uses: actions/checkout@v2
        with:
          persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal access token.
          fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository.

      - name: setup python
        uses: actions/setup-python@v2
        with:
          python-version: 3.8 #install the python needed

      - name: install python packages
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt
        working-directory: tools
        
      - name: execute py script # run the build_readme.py
        run: |
          python build_readme.py
        working-directory: tools