Create a config file spec for watchmaker
Open
Nobody has claimed this yet.
release/1.0.0
- Dominant language
- Python
- Stars
- 42
- Forks
- 31
- Avg merge
- 5h 22m
- Merged PRs (30d)
- 19
Description
Right now, the config file is really a list of workers and worker configs. Running into a couple issues with this approach:
- There isn't really a way to specify options for watchmaker itself, such as the proposed version constraint option, without getting wrapped up in how worker configs are loaded.
- There is no way to process a config other than just running the worker. It would help to have a method that validates the config or sets defaults or deprecates options...
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 reviewing how the current config is represented as a list of workers and how worker configs are loaded. Define the boundaries for watchmaker-level options and config processing such as validation, defaults, and deprecations; done means the proposed config file specification is documented and its intended processing behavior is clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- devops, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100