docs: copyright, changelog, handlers warning [ci skip]

This commit is contained in:
Mohamed El Mouctar HAIDARA 2024-12-29 22:41:55 +01:00
parent 3932ee6406
commit b68c8815f3
5 changed files with 15 additions and 16 deletions
CHANGELOG.mdREADME.md
ansibleplaybookgrapher
cli.py
renderer/graphviz
setup.py

View file

@ -2,26 +2,26 @@
## What's Changed
* fix: Make sure the import_role tasks are always added to the graph. More info
in https://github.com/haidaraM/ansible-playbook-grapher/pull/231.
* feat: Add the handlers to the graph with `--show-handlers` (**initial support for handlers**). They are by default
added at the end of the play and roles only. This might change in the future to actually reflect the handlers' behavior.
* **fix: Make sure the import_role tasks are always added to the graph. More info
at https://github.com/haidaraM/ansible-playbook-grapher/pull/231.**
* **Changes the shape of the graphviz node to make it consistent with Mermaid. The tasks will be rectangle instead of
`octagon`: https://graphviz.org/doc/info/shapes.html**
* **fix: Remove the play name from the edge going from playbook to the plays. This was not consistent with the other edges.**
* feat: Add a new option `--title` to add a title to the graph by @haidaraM
in https://github.com/haidaraM/ansible-playbook-grapher/pull/229. Default to 'Ansible Playbook Grapher'. The graphviz
renderer will now use this as the title (label). The Mermaid renderer already has a title.
* **fix: The tags on the role itself should not be evaluated. Instead, what we care about is the tasks (they inherit the
tags set on the roles).** More
info [here.](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_tags.html#adding-tags-to-roles)
* fix: The playbook `location.path` should be the absolute path + use local paths when testing by @haidaraM
in https://github.com/haidaraM/ansible-playbook-grapher/pull/230.
* "Empty roles" are no longer displayed by default. An empty role is a role with no tasks (after applying the tags
* **"Empty roles" are no longer displayed by default**. An empty role is a role with no tasks (after applying the tags
filters, for example). This is the same behavior as the option `--hide-empty-plays` but with roles. **I will eventually
drop `--hide-empty-plays` to make this the default behavior in the future.**
* feat: Add the initial support for handlers to the graph with `--show-handlers`. They are by default
added at the end of the play and roles only. This might change in the future to actually reflect the handlers' behavior.
* feat: Add a new option `--title` to add a title to the graph by @haidaraM
in https://github.com/haidaraM/ansible-playbook-grapher/pull/229. Default to 'Ansible Playbook Grapher'. The graphviz
renderer will now use this as the title (label). The Mermaid renderer already has a title.
* improvement: Make the play node label like what "ansible-playbook --list-tasks" show. This is more consistent with the
actual playbook output.
* fix: The playbook `location.path` should be the absolute path + use local paths when testing by @haidaraM
in https://github.com/haidaraM/ansible-playbook-grapher/pull/230.
* docs: Add a comparison matrix for the different renderers
* (Internal) Moved some flags out of the parser to the renderer instead. The whole playbook and all the tasks and
roles (except the excluded ones) are always parsed. The renderer(s) will decide later what do based on the flags

View file

@ -95,7 +95,7 @@ Comparison of the renderers:
| Change graph orientation | ❌ | ✅ | ❌: NA |
| Group roles by name | ✅ | ✅ | ✅: the roles with the same names will have the same IDs. |
| Hide empty roles | ✅ | ✅ | ❌: The empty roles are kept in the output |
| View the output file in your the OS default viewer | ✅ | | ✅ |
| View the output file in your the OS default viewer | ✅ | ✅ on https://mermaid.live/ | ✅ |
| Tests of the output | Automatic | Manual (need a parser) | Automatic |
If you are interested to support more renderers, feel free to create an issue or raise a PR based on the existing

View file

@ -409,9 +409,8 @@ class PlaybookGrapherCLI(CLI):
if self.options.show_handlers:
display.warning(
"The handlers are partially supported for the moment. Their position in the graph doesn't entirely reflect "
"their real order of execution in the playbook. They are displayed at the end of the play and roles, "
"but they might be executed before that."
"The handlers are only partially supported for the moment. They are added at the end of the play and roles, "
"but they might be executed before that. As such, expect some changes in the future.",
)
return options

View file

@ -1,4 +1,4 @@
# Copyright (C) 2023 Mohamed El Mouctar HAIDARA
# Copyright (C) 2024 Mohamed El Mouctar HAIDARA
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by

View file

@ -1,4 +1,4 @@
# Copyright (C) 2023 Mohamed El Mouctar HAIDARA
# Copyright (C) 2024 Mohamed El Mouctar HAIDARA
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by