Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

support blind-translated YAML mapping for galaxy deps #515

Merged
merged 2 commits into from
May 3, 2023

Conversation

nitzmahone
Copy link
Member

  • simplify docs accordingly

@nitzmahone nitzmahone requested a review from a team as a code owner May 3, 2023 00:00
@github-actions github-actions bot added docs Changes to documentation needs_triage New item that needs to be triaged labels May 3, 2023
@nitzmahone
Copy link
Member Author

nitzmahone commented May 3, 2023

If the "blind-translated" in the title wasn't enough, we should probably be explicit somewhere in the docs about the fact that by design, we do zero validation of the structure of this YAML beyond requiring that it's a dictionary- we just splat it into a requirements.yml in the root of the build context.

We don't builder to be tightly-coupled to Galaxy CLI's schema, so the fact that it's "YAML-in-YAML" is merely a convenience- we shouldn't rely on this going forward (eg, even though inlining things like ignores here might be really easy and tempting, we should probably resist the urge since it would require us to more fully understand and rewrite the contents of the galaxy dict)...

Copy link
Contributor

@Shrews Shrews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is going to be the preferred format, we should change demo/execution-environment.yml too.

@cidrblock
Copy link

TY. Even without validation against the galaxy expected syntax, the simple fact this is now a structured list will help people spot issues.

@nitzmahone nitzmahone requested a review from Shrews May 3, 2023 15:22
@sivel sivel merged commit 25b184a into ansible:devel May 3, 2023
11 checks passed
@Akasurde Akasurde removed the needs_triage New item that needs to be triaged label Jul 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Changes to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants