docs.yml

name: Run Documentation Validation

on: pull_request

jobs:
  run-docs-validation:
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: .ansible/collections/ansible_collections/linode/cloud
    steps:
      - name: checkout repo
        uses: actions/checkout@v3
        with:
          path: .ansible/collections/ansible_collections/linode/cloud

      - name: update packages
        run: sudo apt-get update -y

      - name: install packages
        run: sudo apt-get install -y make

      - name: setup python 3
        uses: actions/setup-python@v4
        with:
          python-version: '3.x'

      - name: install dependencies
        run: make deps

      - name: make temp directory
        run: mkdir tmp

      - name: copy over old readme
        run: cp README.md tmp/README.md

      - name: generate new docs
        run: DOCS_PATH=tmp/docs make gendocs

      - name: compare docs
        run: diff -r docs tmp/docs

      - name: compare README
        run: diff -r README.md tmp/README.md

      - name: clean up
        run: rm -rf tmp