Have st2 pack install checkout git submodules when cloning a pack repo
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6.5k
- Forks
- 787
- PR merge metrics
- No merged PRs in 30d
Description
When a Pack is installed on Stackstorm using pack install - stackstorm performs a clone on the Repo (Code) - however this results in any submodules present in the repo not being checked out and only being an empty directory.
It would be useful if the clone_repo function also checked out any submodules that are present in the repo, as it would be helpful to add dependencies maintained in seperate repos to the pack as a submodule, while still being maintained externally.
In my use case a series of ansible playbooks are maintained in a seperate repo and I would like to also make them available as a pack to st2, and as I see it the best way to do that is via git submodules.
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 in st2common/st2common/util/pack_management.py at the clone_repo function and review the referenced pack installation path. Update the cloning behavior so repositories with Git submodules have those submodules checked out during pack installation, then verify that a pack containing a submodule is installed with its contents available.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, python
- Domain
- devops
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100