Repository navigation
ci: Prepare for README files generated from argument_specs and extra_specs - #248
Conversation
…specs Generating README.md and README.html from meta/argument_specs.yml and meta/extra_specs.yml has the following advantages: 1. A single source of truth - developers need to manage all information in specs files only. 2. Ansible-themed README familiar to Ansible users. This PR adds: * Distribute check-docs-updated.yml, a workflow_call check wired into citest that runs `tox -e build-docs` and fails if the committed README files are out of date; also add it to the citest known/linters lists and the /citest instructions table * Retire the old pandoc docs mechanism: remove build_docs.yml, test_converting_readme.yml and .pandoc_template.html5, and drop test_converting_readme from citest and its instructions * Skip README CI-badge injection: the generated README carries no badges (the per-check workflows are workflow_call-only and cannot show a meaningful status badge, and an injected badge would also break the check-docs regenerate-and-diff) * Add a workflow that publishes docs to GH pages for roles that generate README from specs * Make codespell ignore README.html instead of .README.html Signed-off-by: Sergei Petrosian <spetrosi@redhat.com>
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the
|
|
CI tests do not run automatically on pull requests. A role repository See GitHub CI testing using /citest Run every available CI workflow: Run the linting and other lightweight checks: Run the integration tests (QEMU/container and Testing Farm): Run one or more selected workflows by separating their names with spaces:
Post another |
Generating README.md and README.html from meta/argument_specs.yml and meta/extra_specs.yml has the following advantages:
This PR adds:
tox -e build-docsand fails if the committed README files are out of date; also add it to the citest known/linters lists and the /citest instructions tableSigned-off-by: Sergei Petrosian spetrosi@redhat.com