Add support for multiple .gitpod.yml files in one repo
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 13.8k
- Forks
- 1.4k
- Avg merge
- 17h 58m
- Merged PRs (30d)
- 5
Description
Hey, thanks for working on this product — big fan!
Feature Request
Support .gitpod.yml files on a per directory basis instead of a per repo basis. This would work similarly to how docker-compose.yml does. With docker-compose.yml, docker first looks for the file in the current directory, and then recurses up the directory hierarchy until it finds one.
How it would work with gitpod is if the URL goes to a repo’s subdirectory, gitpod would first look in that directory for a .gitpod.yml and then recurse up until it finds one.
Use Case
This is an education use case. Often, I’ll have a repo with many subdirectories, each of which containing a separate tutorial. Right now, I can use this workaround, which essentially includes the directory as an environment variable in the URL and then the workspace changes into that directory on launch. This is workable, but assumes every tutorial can be supported by a single configuration. It would be much more flexible to customize the workspace on a per directory basis instead.
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 by tracing how Gitpod resolves .gitpod.yml for a repository URL and how the requested subdirectory is identified. Compare the current single-repository behavior with the proposed search from the URL directory upward; done means the nearest applicable configuration is selected for each tutorial directory, with the existing workaround no longer required.
Written by the indexing model from the issue text.
Assessment
- Domain
- cloud
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100