-
Notifications
You must be signed in to change notification settings - Fork 0
/
issue.md
81 lines (57 loc) · 3.24 KB
/
issue.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
{% set artifact = collection_name.replace(".", "-") ~ "-" ~ tag_output.version ~ ".tar.gz" %}
(Note: This issue was filed in a semi-automated fashion on behalf of the Ansible Community Steering Committee. Let me know if you see errors in this issue.)
{% if test_json or invalid_ignores %}
As per the [Ansible community package inclusion requirements][ci-testing], collections must pass `ansible-test sanity` tests. Version `{{ tag_output.version }}` of `{{ collection_name }}`, corresponding to the `{{ tag_output.tag }}` tag in this repo, fails one or more of the required sanity tests.
{% endif %}
{% if file_errors %}
The contents in the `{{ tag_output.tag }}` git tag do not match `{{ artifact }}` as uploaded to Ansible Galaxy. For future releases, please make sure that the contents uploaded to Galaxy match the sources that were tagged as that release. See the [Repository management requirements][repo-mgmt] for more information.
{% endif %}
Please see the errors below and address them. If these issues aren't addressed within a reasonable time period, the collection may be subject to [removal from Ansible][removal].
*Please fix the issues identified below and then create a new Galaxy release so the fixes are caught in the next round of automated testing.*
Thank you for your efforts and for being part of the Ansible package! We appreciate it.
---
{% if test_json or invalid_ignores %}
## Sanity tests
The following tests were run using `ansible-test` version `{{ env_details.ansible_test_version }}`:
{% for test in env_details.sanity_tests %}
- {{ test }}
{% endfor %}
Note that this is only a subset of the required sanity tests. Please make sure you run them in all in your CI.
### Results
{% if test_json %}
> **💡 NOTE:**
>
> Check the `[explain]` links below for more information about each test and how to fix failures.
> See [Sanity Tests: Ignores](https://docs.ansible.com/ansible/latest/dev_guide/testing/sanity/ignores.html) in the dev guide if, after reading the test-specific documentation, you still believe an error is a false positive.
{% for file in test_json.values() %}
{% for result in file.results %}
{{ result.message }}
``` text
{{ result.output }}
```
{% endfor %}
{% endfor %}
{% else %}
`ansible-test sanity` succeeded, but some required tests were ignored.
{% endif %}
{% if invalid_ignores %}
### Invalid test ignores
`{{ ignores_file }}` contain ignores that are forbidden by the [CI testing requirements][ci-testing]:
``` text
{% for ignore in invalid_ignores %}
{{ ignore.as_str() }}
{% endfor %}
```
Please fix these issues and remove the ignore entries.
{% endif %}
{% endif %}
{% if file_errors %}
## File divergences
The following files differ between the `{{ tag_output.tag }}` git tag and `{{ artifact }}` on Ansible Galaxy:
{% for file in file_errors %}
- `{{ file.file }}` (`{{ file.error }}`{{ (" : " ~ file.message) if "message" in file else "" }})
{% endfor %}
{% endif %}
[ci-testing]: https://docs.ansible.com/ansible/latest/community/collection_contributors/collection_requirements.html#ci-testing
[repo-mgmt]: https://docs.ansible.com/ansible/latest/community/collection_contributors/collection_requirements.html#repository-management
[removal]: https://github.com/ansible-collections/overview/blob/main/removal_from_ansible.rst