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
908 Commits 2 Branches 79 Tags 3.8 MiB
Python 78.6%
Jinja 20.5%
Makefile 0.9%
66b216f64a
Go to file
renovate[bot] 66b216f64a
chore(deps): update devdeps non-major (#742) 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [pytest](https://togithub.com/pytest-dev/pytest)
([changelog](https://docs.pytest.org/en/stable/changelog.html)) |
`8.2.2` -> `8.3.1` |
[![age](https://developer.mend.io/api/mc/badges/age/pypi/pytest/8.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/pytest/8.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/pytest/8.2.2/8.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/pytest/8.2.2/8.3.1?slim=true)](https://docs.renovatebot.com/merge-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.2` -> `0.5.4` |
[![age](https://developer.mend.io/api/mc/badges/age/pypi/ruff/0.5.4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/ruff/0.5.4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/ruff/0.5.2/0.5.4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/ruff/0.5.2/0.5.4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>pytest-dev/pytest (pytest)</summary>

###
[`v8.3.1`](https://togithub.com/pytest-dev/pytest/releases/tag/8.3.1)

[Compare
Source](https://togithub.com/pytest-dev/pytest/compare/8.3.0...8.3.1)

# pytest 8.3.1 (2024-07-20)

The 8.3.0 release failed to include the change notes and docs for the
release. This patch release remedies this. There are no other changes.

###
[`v8.3.0`](https://togithub.com/pytest-dev/pytest/compare/8.2.2...8.3.0)

[Compare
Source](https://togithub.com/pytest-dev/pytest/compare/8.2.2...8.3.0)

</details>

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

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

[Compare
Source](https://togithub.com/astral-sh/ruff/compare/0.5.3...0.5.4)

##### Rule changes

- \[`ruff`] Rename `RUF007` to `zip-instead-of-pairwise`
([#&#8203;12399](https://togithub.com/astral-sh/ruff/pull/12399))

##### Bug fixes

- \[`flake8-builtins`] Avoid shadowing diagnostics for `@override`
methods
([#&#8203;12415](https://togithub.com/astral-sh/ruff/pull/12415))
- \[`flake8-comprehensions`] Insert parentheses for multi-argument
generators
([#&#8203;12422](https://togithub.com/astral-sh/ruff/pull/12422))
- \[`pydocstyle`] Handle escaped docstrings within docstring (`D301`)
([#&#8203;12192](https://togithub.com/astral-sh/ruff/pull/12192))

##### Documentation

- Fix GitHub link to Neovim setup
([#&#8203;12410](https://togithub.com/astral-sh/ruff/pull/12410))
- Fix `output-format` default in settings reference
([#&#8203;12409](https://togithub.com/astral-sh/ruff/pull/12409))

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

[Compare
Source](https://togithub.com/astral-sh/ruff/compare/0.5.2...0.5.3)

**Ruff 0.5.3 marks the stable release of the Ruff language server and
introduces revamped
[documentation](https://docs.astral.sh/ruff/editors), including [setup
guides for your editor of
choice](https://docs.astral.sh/ruff/editors/setup) and [the language
server
itself](https://docs.astral.sh/ruff/editors/settings)**.

##### Preview features

- Formatter: Insert empty line between suite and alternative branch
after function/class definition
([#&#8203;12294](https://togithub.com/astral-sh/ruff/pull/12294))
- \[`pyupgrade`] Implement `unnecessary-default-type-args` (`UP043`)
([#&#8203;12371](https://togithub.com/astral-sh/ruff/pull/12371))

##### Rule changes

- \[`flake8-bugbear`] Detect enumerate iterations in
`loop-iterator-mutation` (`B909`)
([#&#8203;12366](https://togithub.com/astral-sh/ruff/pull/12366))
- \[`flake8-bugbear`] Remove `discard`, `remove`, and `pop` allowance
for `loop-iterator-mutation` (`B909`)
([#&#8203;12365](https://togithub.com/astral-sh/ruff/pull/12365))
- \[`pylint`] Allow `repeated-equality-comparison` for mixed operations
(`PLR1714`)
([#&#8203;12369](https://togithub.com/astral-sh/ruff/pull/12369))
- \[`pylint`] Ignore `self` and `cls` when counting arguments
(`PLR0913`)
([#&#8203;12367](https://togithub.com/astral-sh/ruff/pull/12367))
- \[`pylint`] Use UTF-8 as default encoding in `unspecified-encoding`
fix (`PLW1514`)
([#&#8203;12370](https://togithub.com/astral-sh/ruff/pull/12370))

##### Server

- Build settings index in parallel for the native server
([#&#8203;12299](https://togithub.com/astral-sh/ruff/pull/12299))
- Use fallback settings when indexing the project
([#&#8203;12362](https://togithub.com/astral-sh/ruff/pull/12362))
- Consider `--preview` flag for `server` subcommand for the linter and
formatter
([#&#8203;12208](https://togithub.com/astral-sh/ruff/pull/12208))

##### Bug fixes

- \[`flake8-comprehensions`] Allow additional arguments for `sum` and
`max` comprehensions (`C419`)
([#&#8203;12364](https://togithub.com/astral-sh/ruff/pull/12364))
- \[`pylint`] Avoid dropping extra boolean operations in
`repeated-equality-comparison` (`PLR1714`)
([#&#8203;12368](https://togithub.com/astral-sh/ruff/pull/12368))
- \[`pylint`] Consider expression before statement when determining
binding kind (`PLR1704`)
([#&#8203;12346](https://togithub.com/astral-sh/ruff/pull/12346))

##### Documentation

- Add docs for Ruff language server
([#&#8203;12344](https://togithub.com/astral-sh/ruff/pull/12344))
- Migrate to standalone docs repo
([#&#8203;12341](https://togithub.com/astral-sh/ruff/pull/12341))
- Update versioning policy for editor integration
([#&#8203;12375](https://togithub.com/astral-sh/ruff/pull/12375))

##### Other changes

- Publish Wasm API to npm
([#&#8203;12317](https://togithub.com/astral-sh/ruff/pull/12317))

</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.

👻 **Immortal**: This PR will be recreated if closed unmerged. Get
[config help](https://togithub.com/renovatebot/renovate/discussions) if
that's undesired.

---

- [ ] <!-- 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:eyJjcmVhdGVkSW5WZXIiOiIzNy40MzguMCIsInVwZGF0ZWRJblZlciI6IjM3LjQzOC4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-07-22 03:08:24 +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/wp-docker-buildx docker tag to v5 (#733) 2024-07-08 21:52:04 +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 0bd77ae (#735) 2024-07-11 05:51:52 +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.47.0 (#737) 2024-07-15 03:20:50 +02:00
poetry.lock chore(deps): update devdeps non-major (#742) 2024-07-22 03:08:24 +02:00
pyproject.toml chore(deps): update devdeps non-major (#742) 2024-07-22 03:08:24 +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.