docs(ansible): migrate role READMEs to install_dev_env + --tags#7060
Merged
docs(ansible): migrate role READMEs to install_dev_env + --tags#7060
Conversation
Phase 2 prep for #7052. Replaces the role-specific playbook invocations with the tag-based entry on install_dev_env.yaml so the old wrappers can be deleted. - acados: autoware.dev_env.setup_acados -> install_dev_env --tags acados - artifacts: download_artifacts -> install_dev_env --tags artifacts - qt5ct_setup: install_rviz_theme -> install_dev_env --tags qt5ct_setup - spconv: install_spconv.yaml -> install_dev_env --tags spconv (both standard and Jetson invocations) Signed-off-by: Mete Fatih Cırıt <mfc@autoware.org>
Follow-up on the role README sweep. Two prose references still pointed at the deprecated entrypoints after the tag migration commit. - artifacts: the intro line claimed models download as part of setup-dev-env.sh; point at the ansible-playbook + --tags artifacts invocation instead. - ros2: the Manual Installation section linked universe.yaml as the canonical rosdistro source; point at install_dev_env.yaml which now owns that variable. Signed-off-by: Mete Fatih Cırıt <mfc@autoware.org>
xmfcx
requested review from
isamu-takagi,
mitsudome-r,
oguzkaganozt and
youtalk
as code owners
|
Thank you for contributing to the Autoware project! 🚧 If your pull request is in progress, switch it to draft mode. Please ensure:
|
mitsudome-r
approved these changes
Apr 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
acados,artifacts,qt5ct_setup,spconv, andros2to useansible-playbook autoware.dev_env.install_dev_env --tags <role>instead of the soon-to-be-removed per-role playbooks andsetup-dev-env.sh.setup-dev-env.shin the intro paragraph.rosdistrosource link atinstall_dev_env.yamlinstead ofuniverse.yaml.Why
Phase 1 migration step from #7052: now that
install_dev_env.yamlexists and the per-role playbooks are marked for removal on 2026-05-24, the role READMEs need to point at the supported command so users don't copy-paste deprecated invocations.Test plan
Docs-only change, so verification is limited to checking the new commands resolve and the rendered docs look right.
Each new command parses and runs syntax-check:
Expected:
playbook: ansible/playbooks/install_dev_env.yamlfor all four, no errors.No lingering references to the deprecated commands remain in the touched READMEs:
grep -nE "setup-dev-env\.sh|setup_acados|download_artifacts|install_rviz_theme|install_spconv|universe\.yaml" ansible/roles/{acados,artifacts,qt5ct_setup,spconv,ros2}/README.mdExpected: no matches.
Render each updated README on GitHub after push and confirm code blocks render cleanly.