From 71258c5d61af48c0fa40e495a2990be9a059fd42 Mon Sep 17 00:00:00 2001 From: Rustin170506 Date: Mon, 25 Nov 2024 22:56:44 +0800 Subject: [PATCH 1/2] chore: remove outdated release instructions Signed-off-by: Rustin170506 --- CONTRIBUTING.md | 5 ++--- tracing-attributes/Cargo.toml | 1 - tracing-error/Cargo.toml | 1 - tracing/Cargo.toml | 1 - 4 files changed, 2 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a291ca906e..5e6df6f9e0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -214,7 +214,7 @@ be viewed by clicking the `details` link on the ### Building Documentation Tracing's documentation uses nightly-only RustDoc features and lints, like -`doc(cfg)` and `broken_intra_doc_lints`. These features are enabled by +`doc(cfg)` and `broken_intra_doc_lints`. These features are enabled by passing `--cfg docsrs` to RustDoc. Therefore, in order to build Tracing's documentation the same way it would be built by docs.rs, it's necessary to use the following command: @@ -430,8 +430,7 @@ When releasing a new version of a crate, follow these steps: 2. **Update Cargo metadata.** After releasing any path dependencies, update the `version` field in `Cargo.toml` to the new version, and the `documentation` field to the docs.rs URL of the new version. -3. **Update other documentation links.** Update the `#![doc(html_root_url)]` - attribute in the crate's `lib.rs` and the "Documentation" link in the crate's +3. **Update the "Documentation" link in the crate's `README.md` to point to the docs.rs URL of the new version. 4. **Update the changelog for the crate.** Each crate in the Tokio repository has its own `CHANGELOG.md` in that crate's subdirectory. Any changes to that diff --git a/tracing-attributes/Cargo.toml b/tracing-attributes/Cargo.toml index 145464cd29..9e98f338fe 100644 --- a/tracing-attributes/Cargo.toml +++ b/tracing-attributes/Cargo.toml @@ -2,7 +2,6 @@ name = "tracing-attributes" # When releasing to crates.io: # - Remove path dependencies -# - Update html_root_url. # - Update doc url # - Cargo.toml # - README.md diff --git a/tracing-error/Cargo.toml b/tracing-error/Cargo.toml index 10312ac292..a8e71220a1 100644 --- a/tracing-error/Cargo.toml +++ b/tracing-error/Cargo.toml @@ -2,7 +2,6 @@ name = "tracing-error" # When releasing to crates.io: # - Remove path dependencies -# - Update html_root_url. # - Update doc url # - Cargo.toml # - README.md diff --git a/tracing/Cargo.toml b/tracing/Cargo.toml index 4e4a516968..2b23db1357 100644 --- a/tracing/Cargo.toml +++ b/tracing/Cargo.toml @@ -2,7 +2,6 @@ name = "tracing" # When releasing to crates.io: # - Remove path dependencies -# - Update html_root_url. # - Update doc url # - Cargo.toml # - README.md From 5da6ad145f35c147027d797b7faf9c8b0c326ad7 Mon Sep 17 00:00:00 2001 From: Rustin170506 Date: Sun, 1 Dec 2024 17:07:26 +0800 Subject: [PATCH 2/2] chore: update release instructions to specify README.md for documentation URL updates Signed-off-by: Rustin170506 --- tracing-attributes/Cargo.toml | 4 +--- tracing-core/Cargo.toml | 4 +--- tracing-error/Cargo.toml | 4 +--- tracing/Cargo.toml | 4 +--- 4 files changed, 4 insertions(+), 12 deletions(-) diff --git a/tracing-attributes/Cargo.toml b/tracing-attributes/Cargo.toml index 9e98f338fe..8ab13c062b 100644 --- a/tracing-attributes/Cargo.toml +++ b/tracing-attributes/Cargo.toml @@ -2,9 +2,7 @@ name = "tracing-attributes" # When releasing to crates.io: # - Remove path dependencies -# - Update doc url -# - Cargo.toml -# - README.md +# - Update doc url in README.md. # - Update CHANGELOG.md. # - Create "v0.2.x" git tag. version = "0.2.0" diff --git a/tracing-core/Cargo.toml b/tracing-core/Cargo.toml index 88ff413eac..ef9d36af1a 100644 --- a/tracing-core/Cargo.toml +++ b/tracing-core/Cargo.toml @@ -3,9 +3,7 @@ name = "tracing-core" # When releasing to crates.io: # - Remove path dependencies # - Update html_root_url. -# - Update doc url -# - Cargo.toml -# - README.md +# - Update doc url in README.md. # - Update CHANGELOG.md. # - Create "v0.2.x" git tag. version = "0.2.0" diff --git a/tracing-error/Cargo.toml b/tracing-error/Cargo.toml index a8e71220a1..4731081cd3 100644 --- a/tracing-error/Cargo.toml +++ b/tracing-error/Cargo.toml @@ -2,9 +2,7 @@ name = "tracing-error" # When releasing to crates.io: # - Remove path dependencies -# - Update doc url -# - Cargo.toml -# - README.md +# - Update doc url in README.md. # - Update CHANGELOG.md. # - Create "v0.2.x" git tag version = "0.2.0" diff --git a/tracing/Cargo.toml b/tracing/Cargo.toml index 2b23db1357..ede91b7caa 100644 --- a/tracing/Cargo.toml +++ b/tracing/Cargo.toml @@ -2,9 +2,7 @@ name = "tracing" # When releasing to crates.io: # - Remove path dependencies -# - Update doc url -# - Cargo.toml -# - README.md +# - Update doc url in README.md. # - Update CHANGELOG.md. # - Create "v0.2.x" git tag version = "0.2.0"