@@ -41,7 +41,7 @@ file consists of the following sections:
41
41
* [ ` [dev-dependencies] ` ] ( specifying-dependencies.md#development-dependencies ) — Dependencies for examples, tests, and benchmarks.
42
42
* [ ` [build-dependencies] ` ] ( specifying-dependencies.md#build-dependencies ) — Dependencies for build scripts.
43
43
* [ ` [target] ` ] ( specifying-dependencies.md#platform-specific-dependencies ) — Platform-specific dependencies.
44
- * [ ` [badges] ` ] ( #the-badges-section ) — Badges to display on [ crates.io ] .
44
+ * [ ` [badges] ` ] ( #the-badges-section ) — Badges to display on a registry .
45
45
* [ ` [features] ` ] ( features.md ) — Conditional compilation features.
46
46
* [ ` [patch] ` ] ( overriding-dependencies.md#the-patch-section ) — Override dependencies.
47
47
* [ ` [replace] ` ] ( overriding-dependencies.md#the-replace-section ) — Override dependencies (deprecated).
@@ -459,66 +459,22 @@ default-run = "a"
459
459
460
460
### The ` [badges] ` section
461
461
462
- [ crates.io ] can display various badges for build status, test coverage, etc. for
463
- each crate. All badges are optional .
462
+ The ` [badges] ` section is for specifying status badges that can be displayed
463
+ on a registry website when the package is published .
464
464
465
- - The badges pertaining to build status that are currently available are
466
- Appveyor, CircleCI, Cirrus CI, GitLab, Azure DevOps, Travis CI and Bitbucket
467
- Pipelines.
468
- - Available badges pertaining to code test coverage are Codecov and Coveralls.
469
- - There are also maintenance-related badges based on isitmaintained.com
470
- which state the issue resolution time, percent of open issues, and future
471
- maintenance intentions.
472
-
473
- Most badge specifications require a ` repository ` key. It is expected to be in
474
- ` user/repo ` format.
465
+ > Note: [ crates.io] previously displayed badges next to a crate on its
466
+ > website, but that functionality has been removed. Packages should place
467
+ > badges in its README file which will be displayed on [ crates.io] (see [ the
468
+ > ` readme ` field] ( #the-readme-field ) ).
475
469
476
470
``` toml
477
471
[badges ]
478
-
479
- # Appveyor: `repository` is required. `branch` is optional; default is `master`
480
- # `service` is optional; valid values are `github` (default), `bitbucket`, and
481
- # `gitlab`; `id` is optional; you can specify the appveyor project id if you
482
- # want to use that instead. `project_name` is optional; use when the repository
483
- # name differs from the appveyor project name.
484
- appveyor = { repository = " ..." , branch = " master" , service = " github" }
485
-
486
- # Circle CI: `repository` is required. `branch` is optional; default is `master`
487
- circle-ci = { repository = " ..." , branch = " master" }
488
-
489
- # Cirrus CI: `repository` is required. `branch` is optional; default is `master`
490
- cirrus-ci = { repository = " ..." , branch = " master" }
491
-
492
- # GitLab: `repository` is required. `branch` is optional; default is `master`
493
- gitlab = { repository = " ..." , branch = " master" }
494
-
495
- # Azure DevOps: `project` is required. `pipeline` is required. `build` is optional; default is `1`
496
- # Note: project = `organization/project`, pipeline = `name_of_pipeline`, build = `definitionId`
497
- azure-devops = { project = " ..." , pipeline = " ..." , build =" 2" }
498
-
499
- # Travis CI: `repository` in format "<user>/<project>" is required.
500
- # `branch` is optional; default is `master`
501
- travis-ci = { repository = " ..." , branch = " master" }
502
-
503
- # Bitbucket Pipelines: `repository` is required. `branch` is required
504
- bitbucket-pipelines = { repository = " ..." , branch = " master" }
505
-
506
- # Codecov: `repository` is required. `branch` is optional; default is `master`
507
- # `service` is optional; valid values are `github` (default), `bitbucket`, and
508
- # `gitlab`.
509
- codecov = { repository = " ..." , branch = " master" , service = " github" }
510
-
511
- # Coveralls: `repository` is required. `branch` is optional; default is `master`
512
- # `service` is optional; valid values are `github` (default) and `bitbucket`.
513
- coveralls = { repository = " ..." , branch = " master" , service = " github" }
514
-
515
- # Is it maintained resolution time: `repository` is required.
516
- is-it-maintained-issue-resolution = { repository = " ..." }
517
-
518
- # Is it maintained percentage of open issues: `repository` is required.
519
- is-it-maintained-open-issues = { repository = " ..." }
520
-
521
- # Maintenance: `status` is required. Available options are:
472
+ # The `maintenance` table indicates the status of the maintenance of
473
+ # the crate. This may be used by a registry, but is currently not
474
+ # used by crates.io. See https://github.com/rust-lang/crates.io/issues/2437
475
+ # and https://github.com/rust-lang/crates.io/issues/2438 for more details.
476
+ #
477
+ # The `status` field is required. Available options are:
522
478
# - `actively-developed`: New features are being added and bugs are being fixed.
523
479
# - `passively-maintained`: There are no plans for new features, but the maintainer intends to
524
480
# respond to issues that get filed.
0 commit comments