rust-lang / rustdoc-types

Rustdoc's JSON output interface
Apache License 2.0
28 stars 15 forks source link

Bus Factor/More Maintainers #25

Closed aDotInTheVoid closed 1 week ago

aDotInTheVoid commented 1 year ago

Right now, I'm the only person with write access to this repo/publish perms on crates.io. This isn't desirable for a couple of reasons.

  1. If rustdoc-json changes while I'm away from a computes for an extended period of time, a new release may be delayed, causing needless hassle for users, who may need to move to a fork temporarily
  2. If I'm permanently unable to maintain this, it would be a shame to cause needless turmoil by having to move to a new crate.

Long term, this crate should probably be managed by T-Rustdoc , but in the shorter term, I'd like to give permissions to a second person. I don't anticipate this will be much work, as I intent to continue maintaining this for the forseable future, but they may have to make releases in my absence, and I'd try to communicate with them if I was permanently stepping away.

Before this can be done, we'd probably want to

As the current release process is attrocious (it involves tagging a fake commit, generating the changelog, deleting the tag, ammending the commit, and retagging).

I've thaught of this now, as I'm about to go camping for a week, so won't be able to publish a new version if any come through. I'm not going to make changes before then, as it's too late now, and this needs more time, which is kind of scary as https://github.com/rust-lang/rust/pull/115078 may well be merged when I'm gone. While it's too late to prevent this, I don't want it to happen again.

Enselic commented 1 year ago

I agree T-rustdoc is a better long term owner.

That said, I volunteer to be the second (or third, or fourth) person with publish rights short term 🙋‍♂️

camelid commented 1 year ago

This is a good point, although I'm unclear why we shouldn't add T-rustdoc as an owner now? It's usually better to have a team be the owner rather than individuals since then it's automatically synced with the team repo over time.

aDotInTheVoid commented 1 year ago

mainly because i think there’s more process needed to assign a whole team to it oh gh/crates.io, and it implies a level of “officiality” that’s not true yet. if t-rustdoc is maintaining, it should probably live in the rust gh org.

camelid commented 1 year ago

Ah I see. I thought it was already considered an official crate, but I guess that hasn't been discussed yet. 👍

aDotInTheVoid commented 10 months ago

Update on this. It was discussed on zulip, and we decided on moving to T-rustdoc, in the rust-lang github.

I've opened an RFC (https://github.com/rust-lang/rfcs/pull/3505). It needs to be driven forward. Mainly blocked on needing T-Infra to make sure the perm stuff is right.

aDotInTheVoid commented 2 weeks ago

RFC approved! The move is currently planned to happen some time this week during EuroRust 2024

aDotInTheVoid commented 1 week ago

We're in the rust-lang github, and owned by rustdoc on github!

The firefox url https://github.com/rust-lang/rustdoc-types/issues/25

A crates.io page showing this crate being owned by rustdoc and rust-lang-owner