mirror of
https://github.com/thegeeklab/ansible-doctor.git
synced 2024-11-23 05:10:41 +00:00
e19647a2bb
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ruff](https://docs.astral.sh/ruff) ([source](https://togithub.com/astral-sh/ruff), [changelog](https://togithub.com/astral-sh/ruff/blob/main/CHANGELOG.md)) | `0.5.6` -> `0.5.7` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>astral-sh/ruff (ruff)</summary> ### [`v0.5.7`](https://togithub.com/astral-sh/ruff/blob/HEAD/CHANGELOG.md#057) [Compare Source](https://togithub.com/astral-sh/ruff/compare/0.5.6...0.5.7) ##### Preview features - \[`flake8-comprehensions`] Account for list and set comprehensions in `unnecessary-literal-within-tuple-call` (`C409`) ([#​12657](https://togithub.com/astral-sh/ruff/pull/12657)) - \[`flake8-pyi`] Add autofix for `future-annotations-in-stub` (`PYI044`) ([#​12676](https://togithub.com/astral-sh/ruff/pull/12676)) - \[`flake8-return`] Avoid syntax error when auto-fixing `RET505` with mixed indentation (space and tabs) ([#​12740](https://togithub.com/astral-sh/ruff/pull/12740)) - \[`pydoclint`] Add `docstring-missing-yields` (`DOC402`) and `docstring-extraneous-yields` (`DOC403`) ([#​12538](https://togithub.com/astral-sh/ruff/pull/12538)) - \[`pydoclint`] Avoid `DOC201` if docstring begins with "Return", "Returns", "Yield", or "Yields" ([#​12675](https://togithub.com/astral-sh/ruff/pull/12675)) - \[`pydoclint`] Deduplicate collected exceptions after traversing function bodies (`DOC501`) ([#​12642](https://togithub.com/astral-sh/ruff/pull/12642)) - \[`pydoclint`] Ignore `DOC` errors for stub functions ([#​12651](https://togithub.com/astral-sh/ruff/pull/12651)) - \[`pydoclint`] Teach rules to understand reraised exceptions as being explicitly raised (`DOC501`, `DOC502`) ([#​12639](https://togithub.com/astral-sh/ruff/pull/12639)) - \[`ruff`] Implement `incorrectly-parenthesized-tuple-in-subscript` (`RUF031`) ([#​12480](https://togithub.com/astral-sh/ruff/pull/12480)) - \[`ruff`] Mark `RUF023` fix as unsafe if `__slots__` is not a set and the binding is used elsewhere ([#​12692](https://togithub.com/astral-sh/ruff/pull/12692)) ##### Rule changes - \[`refurb`] Add autofix for `implicit-cwd` (`FURB177`) ([#​12708](https://togithub.com/astral-sh/ruff/pull/12708)) - \[`ruff`] Add autofix for `zip-instead-of-pairwise` (`RUF007`) ([#​12663](https://togithub.com/astral-sh/ruff/pull/12663)) - \[`tryceratops`] Add `BaseException` to `raise-vanilla-class` rule (`TRY002`) ([#​12620](https://togithub.com/astral-sh/ruff/pull/12620)) ##### Server - Ignore non-file workspace URL; Ruff will display a warning notification in this case ([#​12725](https://togithub.com/astral-sh/ruff/pull/12725)) ##### CLI - Fix cache invalidation for nested `pyproject.toml` files ([#​12727](https://togithub.com/astral-sh/ruff/pull/12727)) ##### Bug fixes - \[`flake8-async`] Fix false positives with multiple `async with` items (`ASYNC100`) ([#​12643](https://togithub.com/astral-sh/ruff/pull/12643)) - \[`flake8-bandit`] Avoid false-positives for list concatenations in SQL construction (`S608`) ([#​12720](https://togithub.com/astral-sh/ruff/pull/12720)) - \[`flake8-bugbear`] Treat `return` as equivalent to `break` (`B909`) ([#​12646](https://togithub.com/astral-sh/ruff/pull/12646)) - \[`flake8-comprehensions`] Set comprehensions not a violation for `sum` in `unnecessary-comprehension-in-call` (`C419`) ([#​12691](https://togithub.com/astral-sh/ruff/pull/12691)) - \[`flake8-simplify`] Parenthesize conditions based on precedence when merging if arms (`SIM114`) ([#​12737](https://togithub.com/astral-sh/ruff/pull/12737)) - \[`pydoclint`] Try both 'Raises' section styles when convention is unspecified (`DOC501`) ([#​12649](https://togithub.com/astral-sh/ruff/pull/12649)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 4am on Monday" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View the [repository job log](https://developer.mend.io/github/thegeeklab/ansible-doctor). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC4yMC4xIiwidXBkYXRlZEluVmVyIjoiMzguMjAuMSIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOltdfQ==--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> |
||
|---|---|---|
| .github | ||
| .gitsv | ||
| .woodpecker | ||
| ansibledoctor | ||
| docs | ||
| example | ||
| .dictionary | ||
| .gitignore | ||
| .lycheeignore | ||
| .markdownlint.yml | ||
| .pre-commit-hooks.yaml | ||
| .prettierignore | ||
| Containerfile.multiarch | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| Makefile | ||
| poetry.lock | ||
| pyproject.toml | ||
| README.md | ||
| renovate.json | ||
ansible-doctor
Annotation based documentation for your Ansible roles
This project is based on the idea (and at some parts on the code) of ansible-autodoc by Andres Bott so credits goes to him for his work.
ansible-doctor is a simple annotation like documentation generator based on Jinja2 templates. While ansible-doctor comes with a default template called readme, it is also possible to write custom templates to customize the output or render the data to other formats like HTML or XML as well.
ansible-doctor is designed to work within a CI pipeline to complete the existing testing and deployment workflow. Releases are available as Python Packages on GitHub or PyPI and as Docker Image on Docker Hub.
The full documentation is available at https://ansible-doctor.geekdocs.de.
Contributors
Special thanks to all contributors. If you would like to contribute, please see the instructions.
License
This project is licensed under the GPL-3.0 License - see the LICENSE file for details.