Add role argument spec and action to auto-update readme #3
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| --- | |
| name: create roles readme | |
| on: # yamllint disable-line rule:truthy | |
| push: | |
| branches: [main] | |
| paths: | |
| - 'roles/*/meta/argument_specs.yml' | |
| - 'roles/*/meta/main.yml' | |
| pull_request: | |
| branches: [main] | |
| paths: | |
| - 'roles/*/meta/argument_specs.yml' | |
| - 'roles/*/meta/main.yml' | |
| jobs: | |
| readme: | |
| name: create roles readme | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.11 | |
| - name: Install aar_doc | |
| run: pip3 install aar_doc | |
| - name: Run aar_doc | |
| run: aar_doc --config-file .aar_doc.yml roles/ansible_icinga/ markdown | |
| - name: Push README | |
| if: github.event_name != 'pull_request' | |
| uses: github-actions-x/[email protected] | |
| with: | |
| github-token: ${{ secrets.GITHUB_TOKEN }} | |
| commit-message: 'update readme' | |
| files: README.md | |
| rebase: true |