Feature Request: extending trellis check command
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 169
- Forks
- 30
- Avg merge
- 13h 43m
- Merged PRs (30d)
- 7
Description
Terms
- I have read the guidelines for Contributing to Roots Projects
- This request is not a duplicate of an existing issue
- This is not a personal support request that should be posted on the Roots Discourse community
Summary
Extend the dependency checks the trellis check command carries out to include required provisioning/deployment checks like SSH agent, keys, Ansible.
Motivation
Why are we doing this?
Right now, trellis check looks for Python, Vagrant and Virtualbox compatibility related to local development, but some important checks would be:
- system Ansible version and its compatibility
- SSH agent being enabled
- SSH agent keys being loaded
What use cases does it support?
Would be nice to support checks of any known dependencies of the deploy/provision processes.
What is the expected outcome?
An output like:
Checking Trellis requirements...
Required:
[✓] Ansible [>= 2.9.7]: 2.10.0
[✓] Python [>= 3.8.0]: 3.11.2
[✓] SSH Agent [On]: Yes
[✓] SSH Agent [Loaded]: Yes
Optional:
[✓] Vagrant [>= 2.1.0]: 2.3.4
[✓] VirtualBox [>= 4.3.10]: 6.1.36r152435
...
Potential conflicts / foreseeable issues
May conflict with Ansible version in virtual environment
Additional Context
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the trellis check command and its existing Python, Vagrant, and VirtualBox checks. Review how dependency checks are represented before scoping Ansible compatibility and SSH-agent and key checks, including the possible conflict with a virtual environment. Done means the command reports the required and optional checks in the proposed format.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ansible, go
- Domain
- cli, devops
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100