docs(ansible): align agnocast README with the role - #7293
Conversation
The README described the role at v2.1.2. The tasks changed after that.
- Set the version to 2.3.5.
- Point the upstream link to autowarefoundation/agnocast.
- List the three overridable defaults under Inputs.
- Add the ansible-playbook command with the agnocast tag.
- Install the kernel headers before the kmod, as the role does.
- Check the dkms state with `dkms status agnocast/<version> | grep -q installed`. The old check had no `$` in `{agnocast_version}` and never matched.
- Load the module at boot via /etc/modules-load.d/agnocast.conf.
Signed-off-by: Mete Fatih Cırıt <mfc@autoware.org>
|
Thank you for contributing to the Autoware project! 🚧 If your pull request is in progress, switch it to draft mode. Please ensure:
|
CODEOWNERS is last-match-wins with no owner merging, so the new line repeats the ansible/** owners and appends @Koichi98. Signed-off-by: Mete Fatih Cırıt <mfc@autoware.org>
|
One nit on the description: the role installs |
The snippet was a second copy of the role in shell, and it drifted: an old version, add-apt-repository, and a dkms check that never matched. The Ansible command is now the only installation step, as in the acados and qt5ct_setup READMEs. Signed-off-by: Mete Fatih Cırıt <mfc@autoware.org>
|
Thanks, both points are right. Rather than keep a shell copy of the role in the README, I dropped the manual snippet. The README now has the |
|
|
The other owners in the file are email addresses. The GitHub handle was the only exception. Signed-off-by: Mete Fatih Cırıt <mfc@autoware.org>
|
Thanks, |
Description
The
agnocastrole README described the role at v2.1.2 and carried a shell copy of the tasks. That copy drifted from the role: an old version,add-apt-repositorywhere the role now uses a keyring and a.sourcesfile, and a dkms check that never matched. This PR removes the copy. The Ansible command is the only installation step, as in theacadosandqt5ct_setupREADMEs.autowarefoundation/agnocast.Inputs.agnocast_force_kmod_installis left out, because it only has an effect inside a container.Installationsection with the--tags agnocastcommand and the-e agnocast_version=<version>override.Manual Installationsection.The first version of this PR kept the snippet and updated it. The review comment on this PR pointed out that the
add-apt-repositoryline contradicts the role, and that the headers step overstated the role. Both points are moot without the snippet.This PR also carries one CODEOWNERS line. A PR with that line was based on this branch and merged into it.
How to verify
ansible-playbookcommand matchesansible/playbooks/install_dev_env.yaml.ansible/roles/agnocast/defaults/main.yaml.#ansible-installationanchor exists inansible/README.md.AI usage
AI usage: written with Claude Code, from a comparison of the README against
tasks/main.yamlanddefaults/main.yaml. The rewrite after review was done the same way.Self-review: I ran the whole thing and it works well. I checked every change and approve it, can merge 👍
Verification:
pre-commitpassed on the file. The tag, the inputs, and the anchor were checked against the source files. Theansible-playbookcommand did not run in the authoring session.Comparison against the role
Read
tasks/main.yaml,defaults/main.yaml, andansible/playbooks/install_dev_env.yaml.agnocastis read fromansible/playbooks/install_dev_env.yaml, line 45ansible/roles/agnocast/defaults/main.yaml#ansible-installationanchor exists inansible/README.md, line 7ansible-playbook --tags agnocastcommand. It needs sudo, and the command shape is copied fromacadosandqt5ct_setuppre-commit
pre-commit run --files ansible/roles/agnocast/README.mdmarkdownlintpassed,prettierpassedpre-commit run --all-files