[Task]: Document guidelines for how version guards should be specified for Beam dependencies
- Dominant language
- Java
- Stars
- 8.7k
- Forks
- 4.7k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 196
Description
### What needs to happen?
We should document this in install_requires and potentially in contributor guide and/or release guide sections of developer docs and have some process that enforces absence of obvious mistakes such as:
- depending on an exact version of a dependency.
- specifying '<=' in upper bound instead of a strict '<'.
- omitting explanations for non-obvious choices, such as a too open or too narrow range.
It might be possible to have a unit test or release validation script that automatically verifies some of that.
### Issue Priority
Priority: 2 (default / most normal work should be filed as P2)
### Issue Components
- [X] Component: Python SDK
- [ ] Component: Java SDK
- [ ] Component: Go SDK
- [ ] Component: Typescript SDK
- [ ] Component: IO connector
- [ ] Component: Beam examples
- [ ] Component: Beam playground
- [ ] Component: Beam katas
- [ ] Component: Website
- [ ] Component: Spark Runner
- [ ] Component: Flink Runner
- [ ] Component: Samza Runner
- [ ] Component: Twister2 Runner
- [ ] Component: Hazelcast Jet Runner
- [ ] Component: Google Cloud Dataflow Runner
Contributor guide
Assessment
This issue has not been assessed yet.