rfcs icon indicating copy to clipboard operation
rfcs copied to clipboard

Move `rustdoc-types` crate to T-Rustdoc ownership.

Open aDotInTheVoid opened this issue 2 years ago • 9 comments

Rendered

CC @rust-lang/rustdoc @rust-lang/infra

aDotInTheVoid avatar Oct 03 '23 10:10 aDotInTheVoid

From an infra point of view, I think we can just remove the GitHub section, and have someone from T-rustdoc ping infra on Zulip when the move needs to happen. Infra will then handle it like all repository moves we do.

pietroalbini avatar May 08 '24 12:05 pietroalbini

This was discussed today in the T-rustdoc meeting

TLDR:

  • Infra blocker now solved
  • Needs editing to be clearer around gaurentees (both mainenence and API-wize)
  • Can move to FCP after that.

aDotInTheVoid avatar May 13 '24 19:05 aDotInTheVoid

I've written about the versioning and release guarantees we intend to provide. My impression from the meetings is that everyone broadly supports doing this.

@rfcbot fcp merge

aDotInTheVoid avatar Jul 06 '24 16:07 aDotInTheVoid

Team member @aDotInTheVoid has proposed to merge this. The next step is review by the rest of the tagged team members:

  • [x] @GuillaumeGomez
  • [x] @Manishearth
  • [ ] @Nemo157
  • [x] @aDotInTheVoid
  • [ ] @camelid
  • [x] @fmease
  • [ ] @jsha
  • [x] @notriddle

Concerns:

  • ~~resolve versioning-strategy-clarity~~ resolved by https://github.com/rust-lang/rfcs/pull/3505#issuecomment--2083148599
  • ~~versioning-strategy-clarity~~ resolved by https://github.com/rust-lang/rfcs/pull/3505#issuecomment--2083148790

Once a majority of reviewers approve (and at most 2 approvals are outstanding), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!

See this document for info about what commands tagged team members can give me.

rfcbot avatar Jul 06 '24 16:07 rfcbot

I'd like to make sure that @Manishearth is happy with my resolution to https://github.com/rust-lang/rfcs/pull/3505#discussion_r1443544643 before merging.

@rfcbot concern versioning-strategy-clarity

aDotInTheVoid avatar Jul 06 '24 16:07 aDotInTheVoid

Versioning strat lgtm!

Manishearth avatar Jul 06 '24 16:07 Manishearth

@rfcbot resolve versioning-strategy-clarity

aDotInTheVoid avatar Jul 06 '24 16:07 aDotInTheVoid

To make sure I understand the version strategy correctly, in practical terms does this mean we're going to abandon rustdoc_json_types's FORMAT_VERSION constant in favor of updating the package version (in Cargo.toml)? Essentially migrating from today's pub const FORMAT_VERSION: u32 = $N; to version = "0.$N" before we hit 1.0?

@rfcbot reviewed

fmease avatar Jul 06 '24 20:07 fmease

does this mean we're going to abandon rustdoc_json_types's FORMAT_VERSION constant in favor of updating the package version

No, not at all. We're going to keep increasing FORMAT_VERSION whenever we change the format, and versioning the crates.io release according to SemVer. Those 2 versions are not necessarily linked, eg we could go from pub struct Id(pub String) to pub struct Id(String) without needing to bump FORMAT_VERSION, but it would be a breaking change for the cargo version.

aDotInTheVoid avatar Jul 06 '24 20:07 aDotInTheVoid