-
Bug
-
Resolution: Done
-
Normal
-
crc-2022-11-17
Problem 1:
Licenses on c.r.c Automation Hub are not displayed if a collection uses the “license_file” key in the galaxy.yml file instead of the “license” key.
There are 71 collections in Automation Hub, many internal collections as well, that are using the license_file key instead of the license key.
All of these collections have a blank license displayed.
Problem 2:
If a collection has 2+ licenses listed in the “license” key, they are concatenated together with no formatting, e.g. “Apache2.0GPLv3-or-later”.
galaxy-importer accepts either the license or the license_file keys in galaxy.yml as valid license identifiers and will pass import. Both keys cannot be present at the same time or import will fail. ("mutually exclusive" error)
AH UI looks only for the 'license' key for displaying the license on the collection page. This is causing 71 collections (out of 143) to have a blank license field if they have the 'license_file" key in their galaxy.yml.
This is on crc-automation-hub.
Steps to Reproduce
Problem 1:
Use the 'license_file' key instead of the 'license' key in the galaxy.yml file.
Refer to https://github.com/ansible-collections/amazon.aws/blob/main/galaxy.yml
and https://console.redhat.com/ansible/automation-hub/repo/published/amazon/aws/
Problem 2:
Have multiple license entries under the 'license' key in the galaxy.yml file.
Refer to https://github.com/Pure-Storage-Ansible/FlashArray-Collection/blob/master/galaxy.yml
and https://console.redhat.com/ansible/automation-hub/repo/published/purestorage/flasharray/
Actual Behavior
Problem 1:
Licenses are blank.
Problem 2:
Licenses are concatenated together without formatting (space/commas)
Proposed Solution for Problem 1:
1. The displayed license could be removed completely from Automation Hub, unless there is a specific legal reason for having it displayed. This would solve both Problem 1 and Problem 2.
2. Partners must update their collections to use the “license” key in the galaxy.yml files instead of the “license_file” key. We may receive pushback on this as there are 71 collections to be updated, including internal, and partners may prefer to point to their entire license file rather than listing it as text.
Proposed Solution for Problem 2:
1. [if we keep licenses in the UI] Add formatting for additional license entries in the “license” key, where spaces and a comma are added between license entries.
- mentioned on