Update badges documentation #8180
Conversation
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Eh2406 (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
rust-highfive
added
the
S-waiting-on-review
| @@ -49,6 +49,40 @@ breakage in nightly will not fail your overall build. Please see the | |||
| [GitLab CI](https://docs.gitlab.com/ce/ci/yaml/README.html) for more | |||
| information. | |||
|
|
|||
| ### Github Actions | |||
There was a problem hiding this comment.
This change seems unrelated?
There was a problem hiding this comment.
Oh indeed. Is it ok here or is a seperate pull request better?
There was a problem hiding this comment.
I think it's probably fine to be here.
|
rust-lang/crates.io#2436 (comment) seems to imply that it is not yet deprecated. Is it maybe premature to remove these? FWIW, I don't mind either way, it just seems like this hasn't been set in stone, yet. AFAIK, lib.rs doesn't show these, but do other registries? |
|
The documentation stated, that these badges would be displayed in crates.io. |
|
ping @rust-lang/crates-io are you OK with removing the CI badges documentation at this time, which will show up in the stable docs in 1.45 (July 16)? |
| @@ -49,6 +49,40 @@ breakage in nightly will not fail your overall build. Please see the | |||
| [GitLab CI](https://docs.gitlab.com/ce/ci/yaml/README.html) for more | |||
| information. | |||
|
|
|||
| ### Github Actions | |||
There was a problem hiding this comment.
I think it's probably fine to be here.
|
The crates.io team discuss this in our meeting today, and there were no objections to this change and targeting the 1.45 release. I didn't review the GH Actions additions in this PR, but the removal of all badges with the exception of maintenance status looks great. Thanks! |
| [crates.io] does not display various badges for build status, test coverage, etc. for | ||
| each crate any more. Only the following fields will be shown. |
There was a problem hiding this comment.
I would not start off with what badges don't do. Perhaps start off with a description, such as:
Badges are pieces of status information about a package. They can
be displayed as small images on a package registry website.
Then follow with a description of the badges that are supported by crates.io. I would keep the description of the maintenance badges, and the link to isitmaintained.com, for example.
Then, at the bottom after the example, include a note for anyone who may be confused as to what changed:
Note: [crates.io] previously displayed badges next to a crate on its
website, but that functionality has been removed. Packages should place
badges in its README file and set the readme field so
that the entire README is displayed on [crates.io].
Also, I'm uncertain, but it looks like crates.io is not showing any badges anymore? What is the state of the maintenance badges? Why would someone set them?
Also, the format for the fields is not explained. What is the form for the repository field? Is it a URL to a website? A git URL?
There was a problem hiding this comment.
Since the maintenance status is moved into the gui maybe the whole section should be removed?
|
☔ The latest upstream changes (presumably #8727) made this pull request unmergeable. Please resolve the merge conflicts. Note that reviewers usually do not review pull requests until merge conflicts are resolved! Once you resolve the conflicts, you should change the labels applied by bors to indicate that your PR is ready for review. Post this as a comment to change the labels: |
|
Looks like the problem with the current changes comes from the fact that there's actually nothing left for Cargo to do with badge attributes in the manifest. I think we need to either clarify their reason for existence, or just put the in the "deprecated and not used anymore" category. The latter would require changing the code, as well, to raise a warning when the attribute is used. Anyone knows if there's an issue already open for this? |
|
I think it's fine to wait until there is a decision on how to handle the maintenance status. That is tracked in rust-lang/crates.io#2437 and rust-lang/crates.io#2438. |
|
I'm going to close this now that #8727 is merged. The |
After removal of badges in crates.io the documentation should be updated accordingly.