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

Add !relative_url YAML constructor #1057

Merged
merged 3 commits into from
Oct 8, 2024
Merged

Conversation

cottsay
Copy link
Member

@cottsay cottsay commented Jun 25, 2024

The purpose of this constructor is to support relative URL resolution in arbitrary locations in the buildfarm's configuration YAML. Some fields in the config already implicitly do this (such as the buildfile references from the index), but this will add support for any field to contain a relative URL.

Staging deployment: https://build.test.ros2.org/job/ci__infra_ubuntu_noble_amd64/

Example use: https://github.com/ros2/ros_buildfarm_config/blob/200fcfd96aceaf2d0791682a6b16e80a59669e52/global/ci-infra.yaml#L43-L44

The purpose of this constructor is to support relative URL resolution in
arbitrary locations in the buildfarm's configuration YAML. Some fields
in the config already implicitly do this (such as the buildfile
references from the index), but this will add support for any field to
contain a relative URL.
Copy link
Contributor

@nuclearsandwich nuclearsandwich left a comment

Choose a reason for hiding this comment

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

Ooh! I really like making this an explicit convention.

Do we need to document this somewhere or can we wait to documented in its expected use locations?

@cottsay
Copy link
Member Author

cottsay commented Jun 27, 2024

Yeah, we should probably document this as well as !include somewhere.

I don't currently have a plan to transition the existing implicit URL resolutions to use this, but we could consider a follow-up change to deprecate them at some point.

@cottsay
Copy link
Member Author

cottsay commented Oct 8, 2024

I added docs in the most recent changes. PTAL.

Copy link
Contributor

@nuclearsandwich nuclearsandwich left a comment

Choose a reason for hiding this comment

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

Nice! Thanks for adding docs.

@cottsay cottsay merged commit ba08fbb into master Oct 8, 2024
24 checks passed
@cottsay cottsay deleted the cottsay/yaml-relative-url branch October 8, 2024 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants