Skip to content

Commit

Permalink
docs/polices.md: refine tagging violation issue template (#315)
Browse files Browse the repository at this point in the history
* docs/policies.md: unwrap tagging violation issue template

The Github issue interface uses a version of markdown that treats single
newlines as paragraph breaks as opposed to the standard two newlines, so
let's unwrap the text so it's properly formatted when copy-pasted.

* docs/policies.md: fix extra word in issue template
  • Loading branch information
gotmax23 authored Nov 7, 2023
1 parent f9bcde5 commit acebd37
Showing 1 changed file with 2 additions and 9 deletions.
11 changes: 2 additions & 9 deletions docs/policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,7 @@ In case of violations, the release manager must preform the following steps:
The following issue template can be used:
``` markdown
Hi! As part of the ansible community package release process,
we've determined that version {VERSION} of {COLLECTION} was released to
Ansible Galaxy but not properly tagged in this Git repository.
Hi! As part of the ansible community package release process, we've determined that version {VERSION} of {COLLECTION} was released to Ansible Galaxy but not properly tagged in this Git repository.
This violates the [repository management][1] section of the Collection Requirements:
[1]: https://docs.ansible.com/ansible/devel/community/collection_contributors/collection_requirements.html#repository-management
Expand All @@ -110,12 +108,7 @@ In case of violations, the release manager must preform the following steps:
>
> Additionally, collection artifacts released to Galaxy MUST be built from the sources that are tagged in the collection's git repository as that release. Any changes made during the build process MUST be clearly documented so the collection artifact can be reproduced.
Until this issue is fixed,
ansible package releases will contain {OLD VERSION},
the previous version of this collection that was properly tagged.
If the collection maintainers do not respond to this issue within a
reasonable a amount of time,
the collection is subject to [Removal from ansible][2].
Until this issue is fixed, ansible package releases will contain {OLD VERSION}, the previous version of this collection that was properly tagged. If the collection maintainers do not respond to this issue within a reasonable amount of time, the collection is subject to [Removal from ansible][2].
[2]: https://github.com/ansible-collections/overview/blob/main/removal_from_ansible.rst#collections-not-satisfying-the-collection-requirements
Expand Down

0 comments on commit acebd37

Please sign in to comment.