googleapis / googleapis/librarian
google-cloud-python: design a migration away from defaultVersion
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 45
- Forks
- 62
- Avg merge
- 18h 32m
- Merged PRs (30d)
- 175
Description
Currently we specify a default version in repo metadata, and this is used by the post-processor. Changing the default version is effectively a breaking change, so this isn't something we want to happen implicitly in any generated library, as otherwise adding a new API path might do the wrong thing.
This makes it effectively a required field though, and we'd prefer not to have that - it will make API onboarding for Python more toilsome than for other languages, for example.
We should think carefully about whether we can remove this concept entirely - potentially over the course of a long time.
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 repo metadata supplies defaultVersion to the post-processor, then inspect the relevant generation and API-onboarding entry points. The work is complete when there is an agreed migration path that avoids implicit breaking changes from default-version updates while reducing the required configuration burden.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, python
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100