github/ansible-doctor
0
0
Fork 0
mirror of https://github.com/thegeeklab/ansible-doctor.git synced 2024-11-21 12:20:40 +00:00
Code Issues Projects Releases Wiki Activity
898 Commits 2 Branches 79 Tags 3.8 MiB
Python 78.6%
Jinja 20.5%
Makefile 0.9%
802085ae54
Go to file
renovate[bot] 802085ae54
chore(deps): update dependency ruff to v0.5.0 (#730) 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](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.4.10` -> `0.5.0` |
[![age](https://developer.mend.io/api/mc/badges/age/pypi/ruff/0.5.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/ruff/0.5.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/ruff/0.4.10/0.5.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/ruff/0.4.10/0.5.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>astral-sh/ruff (ruff)</summary>

###
[`v0.5.0`](https://togithub.com/astral-sh/ruff/blob/HEAD/CHANGELOG.md#050)

[Compare
Source](https://togithub.com/astral-sh/ruff/compare/v0.4.10...0.5.0)

Check out the [blog post](https://astral.sh/blog/ruff-v0.5.0) for a
migration guide and overview of the changes!

##### Breaking changes

See also, the "Remapped rules" section which may result in disabled
rules.

- Follow the XDG specification to discover user-level configurations on
macOS (same as on other Unix platforms)
-   Selecting `ALL` now excludes deprecated rules
- The released archives now include an extra level of nesting, which can
be removed with `--strip-components=1` when untarring.
- The release artifact's file name no longer includes the version tag.
This enables users to install via `/latest` URLs on GitHub.

##### Deprecations

The following rules are now deprecated:

- [`syntax-error`](https://docs.astral.sh/ruff/rules/syntax-error/)
(`E999`): Syntax errors are now always shown

##### Remapped rules

The following rules have been remapped to new rule codes:

-
[`blocking-http-call-in-async-function`](https://docs.astral.sh/ruff/rules/blocking-http-call-in-async-function/):
`ASYNC100` to `ASYNC210`
-
[`open-sleep-or-subprocess-in-async-function`](https://docs.astral.sh/ruff/rules/open-sleep-or-subprocess-in-async-function/):
`ASYNC101` split into `ASYNC220`, `ASYNC221`, `ASYNC230`, and `ASYNC251`
-
[`blocking-os-call-in-async-function`](https://docs.astral.sh/ruff/rules/blocking-os-call-in-async-function/):
`ASYNC102` has been merged into `ASYNC220` and `ASYNC221`
-
[`trio-timeout-without-await`](https://docs.astral.sh/ruff/rules/trio-timeout-without-await/):
`TRIO100` to `ASYNC100`
- [`trio-sync-call`](https://docs.astral.sh/ruff/rules/trio-sync-call/):
`TRIO105` to `ASYNC105`
-
[`trio-async-function-with-timeout`](https://docs.astral.sh/ruff/rules/trio-async-function-with-timeout/):
`TRIO109` to `ASYNC109`
-
[`trio-unneeded-sleep`](https://docs.astral.sh/ruff/rules/trio-unneeded-sleep/):
`TRIO110` to `ASYNC110`
-
[`trio-zero-sleep-call`](https://docs.astral.sh/ruff/rules/trio-zero-sleep-call/):
`TRIO115` to `ASYNC115`
-
[`repeated-isinstance-calls`](https://docs.astral.sh/ruff/rules/repeated-isinstance-calls/):
`PLR1701` to `SIM101`

##### Stabilization

The following rules have been stabilized and are no longer in preview:

-
[`mutable-fromkeys-value`](https://docs.astral.sh/ruff/rules/mutable-fromkeys-value/)
(`RUF024`)
-
[`default-factory-kwarg`](https://docs.astral.sh/ruff/rules/default-factory-kwarg/)
(`RUF026`)
- [`django-extra`](https://docs.astral.sh/ruff/rules/django-extra/)
(`S610`)
-
[`manual-dict-comprehension`](https://docs.astral.sh/ruff/rules/manual-dict-comprehension/)
(`PERF403`)
-
[`print-empty-string`](https://docs.astral.sh/ruff/rules/print-empty-string/)
(`FURB105`)
-
[`readlines-in-for`](https://docs.astral.sh/ruff/rules/readlines-in-for/)
(`FURB129`)
-
[`if-expr-min-max`](https://docs.astral.sh/ruff/rules/if-expr-min-max/)
(`FURB136`)
- [`bit-count`](https://docs.astral.sh/ruff/rules/bit-count/)
(`FURB161`)
-
[`redundant-log-base`](https://docs.astral.sh/ruff/rules/redundant-log-base/)
(`FURB163`)
-
[`regex-flag-alias`](https://docs.astral.sh/ruff/rules/regex-flag-alias/)
(`FURB167`)
-
[`isinstance-type-none`](https://docs.astral.sh/ruff/rules/isinstance-type-none/)
(`FURB168`)
-
[`type-none-comparison`](https://docs.astral.sh/ruff/rules/type-none-comparison/)
(`FURB169`)
- [`implicit-cwd`](https://docs.astral.sh/ruff/rules/implicit-cwd/)
(`FURB177`)
-
[`hashlib-digest-hex`](https://docs.astral.sh/ruff/rules/hashlib-digest-hex/)
(`FURB181`)
-
[`list-reverse-copy`](https://docs.astral.sh/ruff/rules/list-reverse-copy/)
(`FURB187`)
- [`bad-open-mode`](https://docs.astral.sh/ruff/rules/bad-open-mode/)
(`PLW1501`)
- [`empty-comment`](https://docs.astral.sh/ruff/rules/empty-comment/)
(`PLR2044`)
-
[`global-at-module-level`](https://docs.astral.sh/ruff/rules/global-at-module-level/)
(`PLW0604`)
-
[`misplaced-bare-raise`](https://docs.astral.sh/ruff/rules/misplaced-bare-raise%60/)
(`PLE0744`)
-
[`non-ascii-import-name`](https://docs.astral.sh/ruff/rules/non-ascii-import-name/)
(`PLC2403`)
- [`non-ascii-name`](https://docs.astral.sh/ruff/rules/non-ascii-name/)
(`PLC2401`)
-
[`nonlocal-and-global`](https://docs.astral.sh/ruff/rules/nonlocal-and-global/)
(`PLE0115`)
-
[`potential-index-error`](https://docs.astral.sh/ruff/rules/potential-index-error/)
(`PLE0643`)
-
[`redeclared-assigned-name`](https://docs.astral.sh/ruff/rules/redeclared-assigned-name/)
(`PLW0128`)
-
[`redefined-argument-from-local`](https://docs.astral.sh/ruff/rules/redefined-argument-from-local/)
(`PLR1704`)
-
[`repeated-keyword-argument`](https://docs.astral.sh/ruff/rules/repeated-keyword-argument/)
(`PLE1132`)
-
[`super-without-brackets`](https://docs.astral.sh/ruff/rules/super-without-brackets/)
(`PLW0245`)
-
[`unnecessary-list-index-lookup`](https://docs.astral.sh/ruff/rules/unnecessary-list-index-lookup/)
(`PLR1736`)
-
[`useless-exception-statement`](https://docs.astral.sh/ruff/rules/useless-exception-statement/)
(`PLW0133`)
-
[`useless-with-lock`](https://docs.astral.sh/ruff/rules/useless-with-lock/)
(`PLW2101`)

The following behaviors have been stabilized:

- [`is-literal`](https://docs.astral.sh/ruff/rules/is-literal/) (`F632`)
now warns for identity checks against list, set or dictionary literals
- [`needless-bool`](https://docs.astral.sh/ruff/rules/needless-bool/)
(`SIM103`) now detects `if` expressions with implicit `else` branches
-
[`module-import-not-at-top-of-file`](https://docs.astral.sh/ruff/rules/module-import-not-at-top-of-file/)
(`E402`) now allows `os.environ` modifications between import statements
-
[`type-comparison`](https://docs.astral.sh/ruff/rules/type-comparison/)
(`E721`) now allows idioms such as `type(x) is int`
- [`yoda-condition`](https://docs.astral.sh/ruff/rules/yoda-conditions/)
(`SIM300`) now flags a wider range of expressions

##### Removals

The following deprecated settings have been removed:

- `output-format=text`; use `output-format=concise` or
`output-format=full`
-   `tab-size`; use `indent-width`

The following deprecated CLI options have been removed:

-   `--show-source`; use `--output-format=full`
-   `--no-show-source`; use `--output-format=concise`

The following deprecated CLI commands have been removed:

-   `ruff <path>`; use `ruff check <path>`
-   `ruff --clean`; use `ruff clean`
- `ruff --generate-shell-completion`; use `ruff
generate-shell-completion`

##### Preview features

- \[`ruff`] Add `assert-with-print-message` rule
([#&#8203;11981](https://togithub.com/astral-sh/ruff/pull/11981))

##### CLI

- Use rule name rather than message in `--statistics`
([#&#8203;11697](https://togithub.com/astral-sh/ruff/pull/11697))
- Use the output format `full` by default
([#&#8203;12010](https://togithub.com/astral-sh/ruff/pull/12010))
- Don't log syntax errors to the console
([#&#8203;11902](https://togithub.com/astral-sh/ruff/pull/11902))

##### Rule changes

- \[`ruff`] Fix false positives if `gettext` is imported using an alias
(`RUF027`)
([#&#8203;12025](https://togithub.com/astral-sh/ruff/pull/12025))
- \[`npy`] Update `trapz` and `in1d` deprecation (`NPY201`)
([#&#8203;11948](https://togithub.com/astral-sh/ruff/pull/11948))
- \[`flake8-bandit`] Modify diagnostic ranges for shell-related rules
([#&#8203;10667](https://togithub.com/astral-sh/ruff/pull/10667))

##### Server

- Closing an untitled, unsaved notebook document no longer throws an
error ([#&#8203;11942](https://togithub.com/astral-sh/ruff/pull/11942))
- Support the usage of tildes and environment variables in `logFile`
([#&#8203;11945](https://togithub.com/astral-sh/ruff/pull/11945))
- Add option to configure whether to show syntax errors
([#&#8203;12059](https://togithub.com/astral-sh/ruff/pull/12059))

##### Bug fixes

- \[`pycodestyle`] Avoid `E203` for f-string debug expression
([#&#8203;12024](https://togithub.com/astral-sh/ruff/pull/12024))
- \[`pep8-naming`] Match import-name ignores against both name and alias
(`N812`, `N817`)
([#&#8203;12033](https://togithub.com/astral-sh/ruff/pull/12033))
- \[`pyflakes`] Detect assignments that shadow definitions (`F811`)
([#&#8203;11961](https://togithub.com/astral-sh/ruff/pull/11961))

##### Parser

- Emit a syntax error for an empty type parameter list
([#&#8203;12030](https://togithub.com/astral-sh/ruff/pull/12030))
- Avoid consuming the newline for unterminated strings
([#&#8203;12067](https://togithub.com/astral-sh/ruff/pull/12067))
- Do not include the newline in the unterminated string range
([#&#8203;12017](https://togithub.com/astral-sh/ruff/pull/12017))
- Use the correct range to highlight line continuation errors
([#&#8203;12016](https://togithub.com/astral-sh/ruff/pull/12016))
- Consider 2-character EOL before line continuations
([#&#8203;12035](https://togithub.com/astral-sh/ruff/pull/12035))
- Consider line continuation character for re-lexing
([#&#8203;12008](https://togithub.com/astral-sh/ruff/pull/12008))

##### Other changes

- Upgrade the Unicode table used for measuring the line-length
([#&#8203;11194](https://togithub.com/astral-sh/ruff/pull/11194))
- Remove the deprecation error message for the nursery selector
([#&#8203;10172](https://togithub.com/astral-sh/ruff/pull/10172))

</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 has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/thegeeklab/ansible-doctor).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MjEuMCIsInVwZGF0ZWRJblZlciI6IjM3LjQyMS4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-07-01 03:14:45 +02:00
.github use list style synatx and cleanup (#619) 2023-12-23 23:24:56 +01:00
.gitsv chore: replace git-chglog by git-sv (#574) 2023-10-16 15:43:04 +02:00
.woodpecker chore(deps): update quay.io/thegeeklab/hugo docker tag to v0.127.0 (#713) 2024-06-10 07:27:41 +02:00
ansibledoctor fix: fix syntax issue in annotation parser (#725) 2024-06-22 20:49:16 +02:00
docs fix: fix syntax issue in annotation parser (#725) 2024-06-22 20:49:16 +02:00
example feat: add option to load templates from remote git sources (#717) 2024-06-12 20:59:55 +02:00
.dictionary fix: fix syntax issue in annotation parser (#725) 2024-06-22 20:49:16 +02:00
.gitignore refctor: migrate flake8 to ruff python linter (#429) 2023-01-20 11:56:12 +01:00
.lycheeignore ci: exclude dockerhub from linkcheck due to rate limiting 2023-12-07 09:08:22 +01:00
.markdownlint.yml chore: unifi jinja template syntax and add linting (#704) 2024-06-02 09:00:07 +02:00
.pre-commit-hooks.yaml fix: install extra group when using pre-commit (#687) 2024-04-24 08:54:48 +02:00
.prettierignore ci: migrate to woodpecker (#543) 2023-08-25 00:02:01 +02:00
Containerfile.multiarch chore(docker): update python:3.12-alpine docker digest to ff870bf (#729) 2024-06-28 03:37:18 +02:00
CONTRIBUTING.md fix bare url in contribution file (#488) 2023-05-03 09:31:07 +02:00
LICENSE chore: end of the year maintenance 2021-12-21 10:15:38 +01:00
Makefile chore(deps): update dependency thegeeklab/hugo-geekdoc to v0.46.0 2024-06-10 03:08:33 +02:00
poetry.lock chore(deps): update dependency ruff to v0.5.0 (#730) 2024-07-01 03:14:45 +02:00
pyproject.toml chore(deps): update dependency ruff to v0.5.0 (#730) 2024-07-01 03:14:45 +02:00
README.md ci: migrate to woodpecker (#543) 2023-08-25 00:02:01 +02:00
renovate.json separate minor-patch for ansible deps 2024-04-12 09:23:00 +02:00

README.md

ansible-doctor

Annotation based documentation for your Ansible roles

Build Status Docker Hub Quay.io Python Version PyPI Status PyPI Release GitHub contributors Source: GitHub License: GPL-3.0

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.