oxidecomputer / oxidecomputer/omicron
Enforce API version is the same as type module name
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 572
- Forks
- 97
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 96
Description
When adding a new version module (e.g. sled-agent/types/versions/src/lib.rs) devs need to make sure the name of the module (e.g. v22) matches the version of the API in sled-agent/api/src/lib.rs . This seems pretty straightforward, but it can get confusing when the previous version didn't make any changes to the types for whatever reason as seen in https://github.com/oxidecomputer/omicron/pull/9899/files#r2850104877. I can see us easily naming the module the wrong version because of this.
It would be really nice to somehow enforce that the new version module always matches what is in */api/src/lib.rs
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 comparing the version modules in sled-agent/types/versions/src/lib.rs with the API version declared in sled-agent/api/src/lib.rs, including the unchanged-types case discussed in PR 9899. Identify an enforcement point that rejects mismatched names, and verify that matching versions remain valid while mismatches fail through the project's existing checks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100