ansible-doctor

GitHub Action to generate docs for Ansible roles.

Usage

name: Example

on:
  - push
  - pull_request

jobs:
  test:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2

      - uses: actionhippie/ansible-doctor@v1
        with:
          config: optional/path/to/.doctor.yml

Inputs

config

Path to configuration file

output

Base directory to output result

force

Force overwrite the output file, defaults to false

dry_run

Dry run without writing output, defaults to false

role_detection

Automatic role detection, defaults to true

verbose

Increase logging level, defaults to false

quiet

Decrease logging level, defaults to false

path

Path of role directory, defaults to working dir

Outputs

None

Security

If you find a security issue please contact [email protected] first.

Contributing

Fork -> Patch -> Push -> Pull Request

Authors

• Thomas Boerger

License

Apache-2.0

Copyright

Copyright (c) 2021 Thomas Boerger <[email protected]>