Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tracking Issue for RFC 3052: make the authors field optional #83227

Closed
3 of 5 tasks
pietroalbini opened this issue Mar 17, 2021 · 15 comments · Fixed by rust-lang/crates.io#3549
Closed
3 of 5 tasks

Tracking Issue for RFC 3052: make the authors field optional #83227

pietroalbini opened this issue Mar 17, 2021 · 15 comments · Fixed by rust-lang/crates.io#3549
Assignees
Labels
B-RFC-approved Blocker: Approved by a merged RFC but not yet implemented. C-tracking-issue Category: An issue tracking the progress of sth. like the implementation of an RFC T-cargo Relevant to the cargo team, which will review and decide on the PR/issue. T-crates-io Relevant to the crates.io team, which will review and decide on the PR/issue. T-docs-rs Relevant to the docs-rs subteam, which will review and decide on the PR/issue.

Comments

@pietroalbini
Copy link
Member

pietroalbini commented Mar 17, 2021

This is a tracking issue for the RFC "Make the authors field optional" (rust-lang/rfcs#3052).

About tracking issues

Tracking issues are used to record the overall progress of implementation. They are also used as hubs connecting to other relevant issues, e.g., bugs or open design questions. A tracking issue is however not meant for large scale discussion, questions, or bug reports about a feature. Instead, open a dedicated issue for the specific matter and add the relevant feature gate label.

Steps

  • Implement the RFC
    • cargo: stop including authorship information in cargo new/cargo init and in templates
    • crates.io: start accepting crates without authorship information
    • crates.io: stop displaying and serving authorship information
    • docs.rs: stop displaying and serving authorship information

Implementation history

@pietroalbini pietroalbini added B-RFC-approved Blocker: Approved by a merged RFC but not yet implemented. T-cargo Relevant to the cargo team, which will review and decide on the PR/issue. C-tracking-issue Category: An issue tracking the progress of sth. like the implementation of an RFC T-docs-rs Relevant to the docs-rs subteam, which will review and decide on the PR/issue. T-crates-io Relevant to the crates.io team, which will review and decide on the PR/issue. labels Mar 17, 2021
@Rustin170506
Copy link
Member

Rustin170506 commented Mar 17, 2021

Do you need help with this issue? I am very interested in implementing it.

@lf-
Copy link
Contributor

lf- commented Mar 17, 2021

I'm also interested incurrently looking into the cargo side.

@Rustin170506
Copy link
Member

I will finish the rest of the task.

@rustbot claim

@pietroalbini
Copy link
Member Author

Thanks for the interest in implementing this ❤️

@hi-rustin to avoid duplicating work, note that there is a PR to stop displaying the field in the crates.io UI open already (rust-lang/crates.io#3132) since before this tracking issue was open. Added that PR and lf-'s one to the issue text.

@Rustin170506
Copy link
Member

Thanks for the interest in implementing this ❤️

@hi-rustin to avoid duplicating work, note that there is a PR to stop displaying the field in the crates.io UI open already (rust-lang/crates.io#3132) since before this tracking issue was open. Added that PR and lf-'s one to the issue text.

Got it. Thanks!

bors added a commit to rust-lang/crates.io that referenced this issue Mar 19, 2021
start accepting crates without authorship information

See rust-lang/rust#83227
bors added a commit to rust-lang/cargo that referenced this issue Mar 22, 2021
RFC 3052: Stop including authors field in manifests made by cargo new

See rust-lang/rust#83227

~~This is definitely a draft as there are a couple of tests I'm still working on fixing.~~ One question I ran into while digging through these test failures is that there is a Cargo config option for author name, `cargo-new.name`. Should we keep supporting that? I feel like perhaps we should as the user has specified explicit intent that they want their name in the authors of a manifest as generated by `cargo new`, but it seems weird to support *just* that case. There is likewise an environment variable `CARGO_NAME` that signals similar intent.

Should we completely drop the feature of putting in author names, and require people to manually put them in if they wish, or allow these limited cases where the user is specifically instructing *cargo* to do it?
@Rustin170506
Copy link
Member

Rustin170506 commented Mar 23, 2021

* crates.io: stop displaying and serving authorship information

@pietroalbini I think this already done. See also: rust-lang/crates.io#3132 (comment)

image

@Rustin170506
Copy link
Member

Adjust documentation

What other documents need to be updated?

@Rustin170506
Copy link
Member

@pietroalbini Could you please take a look?

@pksunkara
Copy link
Contributor

I just came across this. How does this change the CARGO_PKG_AUTHORS? I would need to update clap for this.

@lf-
Copy link
Contributor

lf- commented Apr 5, 2021

I just came across this. How does this change the CARGO_PKG_AUTHORS? I would need to update clap for this.

Hi! This does not change CARGO_PKG_AUTHORS. All the current changes do is hide the authors field in various websites' UI and make it much harder to accidentally include it in a package as cargo-new does not introduce it. If you handle CARGO_PKG_AUTHORS being empty already (it was allowed to be before these changes, you just couldn't upload such crates to crates.io), you don't have to change anything.

@pietroalbini
Copy link
Member Author

Sorry for taking a while to respond!

I think this already done. See also: rust-lang/crates.io#3132 (comment)

The two other actions needed on the crates.io side are:

What other documents need to be updated?

Removed that point, it was a leftover from the tracking issue template.

@Rustin170506
Copy link
Member

Got it. I will working on these.

@Rustin170506
Copy link
Member

image
@pietroalbini It seems that the action state in the Issue body is lost?

@pietroalbini
Copy link
Member Author

Whelp, not sure how that happened, fixed it!

@Rustin170506
Copy link
Member

cc: rust-lang/docs.rs#1323

bors added a commit to rust-lang/crates.io that referenced this issue Apr 23, 2021
Return the empty list for authors API

Part of rust-lang/rust#83227 (comment)

Stop returning authorship information from the API, changing the endpoint to always return an empty list.
labbott added a commit to oxidecomputer/hubris that referenced this issue Nov 17, 2021
The author's field is now optional per
rust-lang/rust#83227

For sake of clarity, remove it across Hubris
steveklabnik pushed a commit to oxidecomputer/hubris that referenced this issue Nov 17, 2021
The author's field is now optional per
rust-lang/rust#83227

For sake of clarity, remove it across Hubris
yvt added a commit to r3-os/r3 that referenced this issue Dec 14, 2021
It has been effectively soft-deprecated
(<rust-lang/rust#83227>).
ROMemories added a commit to ROMemories/ariel-os that referenced this issue Dec 3, 2024
The `authors` key has been soft-deprecated since 2021 [^1], is not
included by `cargo new` anymore [^2], and is not displayed by crate
registry pages.

[1]: rust-lang/rust#83227
[2]: rust-lang/cargo#9282
ROMemories added a commit to ROMemories/ariel-os that referenced this issue Dec 3, 2024
The `authors` key has been soft-deprecated since 2021 [1], is not
included by `cargo new` anymore [2], and is not displayed by crate
registry pages.

[1]: rust-lang/rust#83227
[2]: rust-lang/cargo#9282
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
B-RFC-approved Blocker: Approved by a merged RFC but not yet implemented. C-tracking-issue Category: An issue tracking the progress of sth. like the implementation of an RFC T-cargo Relevant to the cargo team, which will review and decide on the PR/issue. T-crates-io Relevant to the crates.io team, which will review and decide on the PR/issue. T-docs-rs Relevant to the docs-rs subteam, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants