Improve profile information on summary line #3637
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There are currently two problems with the message in the summary line: If the required and passed profiles are the same, we output something like "Profile 'production' was required, but only 'production' profile passed." This isn't very clear because it looks like the profile was required, but we did not manage to pass it. Furthermore, profiles have no relation to each other. We have no way of knowing which profile is superior to the other, so we cannot compare them in any way. To improve the clarity of the summary line, we remove the word 'only' in case we do not pass the required profile, and if the required and passed profiles are the same, we only state that the profile was passed. Signed-off-by: Daniel Ziegenberg <daniel@ziegenberg.at>
audgirka
approved these changes
Aug 1, 2023
nrdufour
added a commit
to nrdufour/home-ops
that referenced
this pull request
Aug 22, 2023
This PR contains the following updates: | Package | Update | Change | |---|---|---| | [ansible-lint](https://github.com/ansible/ansible-lint) ([changelog](https://github.com/ansible/ansible-lint/releases)) | minor | `==6.17.2` -> `==6.18.0` | --- ### Release Notes <details> <summary>ansible/ansible-lint (ansible-lint)</summary> ### [`v6.18.0`](https://github.com/ansible/ansible-lint/releases/tag/v6.18.0) [Compare Source](ansible/ansible-lint@v6.17.2...v6.18.0) #### Minor Changes - Limit the maximum block depth ([#​3602](ansible/ansible-lint#3602)) [@​Ruchip16](https://github.com/Ruchip16) - Transform functionality for command_instead_of_shell ([#​3675](ansible/ansible-lint#3675)) [@​ajinkyau](https://github.com/ajinkyau) - Add rule to check the number of tasks ([#​3156](ansible/ansible-lint#3156)) [@​Ruchip16](https://github.com/Ruchip16) #### Bugfixes - Clarify loop-var-prefix rule and code snippet ([#​3642](ansible/ansible-lint#3642)) [@​schwarmco](https://github.com/schwarmco) - Update `version_added` for complexity rule ([#​3623](ansible/ansible-lint#3623)) [@​ajinkyau](https://github.com/ajinkyau) - Ensure that single space between tasks is preserved when using --write ([#​3641](ansible/ansible-lint#3641)) [@​shatakshiiii](https://github.com/shatakshiiii) - Update ansible-compat used for testing ([#​3664](ansible/ansible-lint#3664)) [@​ssbarnea](https://github.com/ssbarnea) - Document `yaml[line-length]` rule ([#​3653](ansible/ansible-lint#3653)) [@​shatakshiiii](https://github.com/shatakshiiii) - Prevent use of spdx-tools 0.8.0 due to breaking changes ([#​3649](ansible/ansible-lint#3649)) [@​ssbarnea](https://github.com/ssbarnea) - fixes dead marketplace link ([#​3631](ansible/ansible-lint#3631)) [@​wookietreiber](https://github.com/wookietreiber) - Improve profile information on summary line ([#​3637](ansible/ansible-lint#3637)) [@​ziegenberg](https://github.com/ziegenberg) - command-instead-of-module: allow `git rev-parse` ([#​3610](ansible/ansible-lint#3610)) [@​JohnVillalovos](https://github.com/JohnVillalovos) - Include filepaths starting from $HOME in lintables ([#​3621](ansible/ansible-lint#3621)) [@​shatakshiiii](https://github.com/shatakshiiii) - Update \_mockings.py to fix bug created in [#​3390](ansible/ansible-lint#3390) ([#​3614](ansible/ansible-lint#3614)) [@​karcaw](https://github.com/karcaw) - Allow to set gather_facts as templated boolean ([#​3606](ansible/ansible-lint#3606)) [@​noonedeadpunk](https://github.com/noonedeadpunk) - Add dependency version check for collection metadata ([#​3601](ansible/ansible-lint#3601)) [@​ajinkyau](https://github.com/ajinkyau) - Fix installation of dependencies when run as an action ([#​3592](ansible/ansible-lint#3592)) [@​ssbarnea](https://github.com/ssbarnea) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **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 [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi4yMy4yIiwidXBkYXRlZEluVmVyIjoiMzYuMjMuMiIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==--> Reviewed-on: https://git.home/nrdufour/home-ops/pulls/49 Co-authored-by: Renovate <renovate@ptinem.io> Co-committed-by: Renovate <renovate@ptinem.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There are currently two problems with the message in the summary line:
If the required and passed profiles are the same, we output something like "Profile 'production' was required, but only 'production' profile passed." This isn't very clear because it looks like the profile was required, but we did not manage to pass it.
Furthermore, profiles have no relation to each other. We have no way of knowing which profile is superior to the other, so we cannot compare them in any way.
To improve the clarity of the summary line, we remove the word 'only' in case we do not pass the required profile, and if the required and passed profiles are the same, we only state that the profile was passed.