Collection checklist #90
Conversation
Requirements for Collections to be included in Ansible This is currently in bullet point form, we can expand over time. This could live else where, though I realise it hasn't been captured at all so far. Commits to update wording here are welcome.
|
In a previous meeting, people wanted new collections to have a minimum version of 1.0.0. I am unconvinced either way at the moment, but it was a popular criteria. |
|
@gundalow i'm not sure the things i added are fully relevant to the doc's goal. If not, just push "Resolve conversation". |
|
I'm +1 on requiring 1.0.0 or later of a collection. Everything before 1.0.0 can do essentially random things in every new release according to semver. |
Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Sandra McCann <samccann@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
|
sivel brought up today that collections sometimes have virtualenvs or ansible-test output. That appears to happen when running
|
Co-authored-by: Felix Fontein <felix@fontein.de>
There was a problem hiding this comment.
Sigh. TIL - delete a suggested edit and it deletes all the comments on it. Possibly a good thing, but just FYI felix made a valid comment on my suggested edit (that it was wrong and that it was already documented further up the page). So I deleted the suggested edit...just...so's..y'all know.
Co-authored-by: Felix Fontein <felix@fontein.de>
collection_requirements.rst
Outdated
| Repo management | ||
| =============== | ||
|
|
||
| Repo name |
There was a problem hiding this comment.
| Repo name | |
| Repo name |
Roaming around the collections i noticed a bit strange things as parts of FQCNs like vyos.vyos.*. We definitely should put some recommendations here. Maybe later though
There was a problem hiding this comment.
Yes, indeed, and with all modules name starting with also vyos_ so you end up with vyos.vyos.vyos_foo ... . I tried to open issues about that on some projects, but now it's a bit too late.
There was a problem hiding this comment.
@Andersson007 Do you think we should providing some naming advice for collections ?
There was a problem hiding this comment.
@bmillemathias sure, it could be general points without giving concrete examples how people shouldn't do :)
E.g. meaning (and we can see something similar in every book about programming)
- try not to use very long names but if you think it's better / necessary, feel free to do it
- choosing a name try to avoid repetitive parts in it
- ...
Something like that.
I definitely shoul think about it. If you feel the same and have something to suggest, it would be really great:)
Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
Requirements for Collections to be included in Ansible
This is currently in bullet point form, we can expand over time.
This could live elsewhere, though I realise it hasn't been captured at all so far.
Commits to update wording here are welcome.