From 19b5e2356cf3515e673c8c98a3ed5f5ef2054712 Mon Sep 17 00:00:00 2001 From: Eric Huss Date: Tue, 28 Jan 2025 18:52:33 -0800 Subject: [PATCH 1/4] Move changelog to the cargo book Due to rendering limits with GitHub's markdown renderer, we're moving the changelog to the cargo book where it can be statically served under our control. --- .github/workflows/contrib.yml | 2 +- .github/workflows/main.yml | 2 +- src/doc/book.toml | 7 ++++++- src/doc/contrib/src/process/release.md | 2 +- src/doc/contrib/src/process/security.md | 2 +- CHANGELOG.md => src/doc/src/CHANGELOG.md | 0 src/doc/src/SUMMARY.md | 1 + src/doc/src/index.md | 2 +- 8 files changed, 12 insertions(+), 6 deletions(-) rename CHANGELOG.md => src/doc/src/CHANGELOG.md (100%) diff --git a/.github/workflows/contrib.yml b/.github/workflows/contrib.yml index 5756c5136dd..02dd4396afa 100644 --- a/.github/workflows/contrib.yml +++ b/.github/workflows/contrib.yml @@ -23,7 +23,7 @@ jobs: - name: Install mdbook run: | mkdir mdbook - curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.40/mdbook-v0.4.40-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook + curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.44/mdbook-v0.4.44-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook echo `pwd`/mdbook >> $GITHUB_PATH - name: Deploy docs run: | diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 04da8bd1688..286894aea4f 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -261,7 +261,7 @@ jobs: - name: Install mdbook run: | mkdir mdbook - curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.40/mdbook-v0.4.40-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook + curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.44/mdbook-v0.4.44-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook echo `pwd`/mdbook >> $GITHUB_PATH - run: cd src/doc && mdbook build --dest-dir ../../target/doc - name: Run linkchecker.sh diff --git a/src/doc/book.toml b/src/doc/book.toml index 7c70eb99892..d815ad9755c 100644 --- a/src/doc/book.toml +++ b/src/doc/book.toml @@ -6,7 +6,12 @@ author = "Alex Crichton, Steve Klabnik and Carol Nichols, with contributions fro smart-punctuation = true # Enable smart-punctuation feature for more than quotes. git-repository-url = "https://github.com/rust-lang/cargo/tree/master/src/doc/src" edit-url-template = "https://github.com/rust-lang/cargo/edit/master/src/doc/{path}" -search.use-boolean-and = true + +[output.html.search] +use-boolean-and = true + +[output.html.search.chapter] +"CHANGELOG.md" = { enable = false } [output.html.redirect] "/guide/build-cache.html" = "../reference/build-cache.html" diff --git a/src/doc/contrib/src/process/release.md b/src/doc/contrib/src/process/release.md index c994fabaf20..e3939e28e41 100644 --- a/src/doc/contrib/src/process/release.md +++ b/src/doc/contrib/src/process/release.md @@ -183,7 +183,7 @@ The process here is similar to the beta-backporting process. The [choochoo]: https://doc.rust-lang.org/book/appendix-07-nightly-rust.html [rust-lang/rust]: https://github.com/rust-lang/rust/ [rust-lang/cargo]: https://github.com/rust-lang/cargo/ -[CHANGELOG]: https://github.com/rust-lang/cargo/blob/master/CHANGELOG.md +[CHANGELOG]: https://github.com/rust-lang/cargo/blob/master/src/doc/src/CHANGELOG.md [release process]: https://forge.rust-lang.org/release/process.html [`TargetInfo`]: https://github.com/rust-lang/cargo/blob/master/src/cargo/core/compiler/build_context/target_info.rs [crates.io]: https://crates.io/ diff --git a/src/doc/contrib/src/process/security.md b/src/doc/contrib/src/process/security.md index 84e587d7aaa..6db9c381173 100644 --- a/src/doc/contrib/src/process/security.md +++ b/src/doc/contrib/src/process/security.md @@ -131,6 +131,6 @@ Post release: [GHSA-r5w3-xm58-jv6j]: https://github.com/rust-lang/cargo/security/advisories/GHSA-r5w3-xm58-jv6j [handling reports]: https://github.com/rust-lang/wg-security-response/blob/main/docs/handling-reports.md [first-guide]: https://www.first.org/cvss/user-guide -[`CHANGELOG.md`]: https://github.com/rust-lang/cargo/blob/master/CHANGELOG.md +[`CHANGELOG.md`]: https://github.com/rust-lang/cargo/blob/master/src/doc/src/CHANGELOG.md [`Cargo.toml`]: https://github.com/rust-lang/cargo/blob/master/Cargo.toml [`RELEASES.md`]: https://github.com/rust-lang/rust/blob/master/RELEASES.md diff --git a/CHANGELOG.md b/src/doc/src/CHANGELOG.md similarity index 100% rename from CHANGELOG.md rename to src/doc/src/CHANGELOG.md diff --git a/src/doc/src/SUMMARY.md b/src/doc/src/SUMMARY.md index 67c38b94251..d66d65f1228 100644 --- a/src/doc/src/SUMMARY.md +++ b/src/doc/src/SUMMARY.md @@ -97,5 +97,6 @@ * [Deprecated and Removed](commands/deprecated-and-removed.md) * [FAQ](faq.md) +* [Changelog](CHANGELOG.md) * [Appendix: Glossary](appendix/glossary.md) * [Appendix: Git Authentication](appendix/git-authentication.md) diff --git a/src/doc/src/index.md b/src/doc/src/index.md index a7b01c60b6b..9fa65b79341 100644 --- a/src/doc/src/index.md +++ b/src/doc/src/index.md @@ -34,7 +34,7 @@ The commands will let you interact with Cargo using its command-line interface. * [Git Authentication](appendix/git-authentication.md) **Other Documentation:** -* [Changelog](https://github.com/rust-lang/cargo/blob/master/CHANGELOG.md) +* [Changelog](CHANGELOG.md) --- Detailed notes about changes in Cargo in each release. * [Rust documentation website](https://doc.rust-lang.org/) --- Links to official Rust documentation and tools. From 767445df48107110b129d55b30e181265fc82c41 Mon Sep 17 00:00:00 2001 From: Eric Huss Date: Tue, 28 Jan 2025 18:53:21 -0800 Subject: [PATCH 2/4] Backing up changelog --- CHANGELOG.md => CHANGELOG.md.bak | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename CHANGELOG.md => CHANGELOG.md.bak (100%) diff --git a/CHANGELOG.md b/CHANGELOG.md.bak similarity index 100% rename from CHANGELOG.md rename to CHANGELOG.md.bak From 2e65c8913eb7560343ecde332d1979f0c09409fc Mon Sep 17 00:00:00 2001 From: Eric Huss Date: Tue, 28 Jan 2025 18:55:13 -0800 Subject: [PATCH 3/4] Keeping changelog to retain history This is so that we temporarily keep a copy of the CHANGELOG in the original location until the website is updated. --- CHANGELOG.md.bak => CHANGELOG.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename CHANGELOG.md.bak => CHANGELOG.md (100%) diff --git a/CHANGELOG.md.bak b/CHANGELOG.md similarity index 100% rename from CHANGELOG.md.bak rename to CHANGELOG.md From 790c776f1a50644ec13b83d926a8988de6ae4274 Mon Sep 17 00:00:00 2001 From: Eric Huss Date: Tue, 28 Jan 2025 20:23:13 -0800 Subject: [PATCH 4/4] Fix broken markdown syntax --- src/doc/src/CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/doc/src/CHANGELOG.md b/src/doc/src/CHANGELOG.md index 8ec33623364..c1ee4f243e7 100644 --- a/src/doc/src/CHANGELOG.md +++ b/src/doc/src/CHANGELOG.md @@ -2694,7 +2694,7 @@ [#11790](https://github.com/rust-lang/cargo/pull/11790) - Broke endless loop on cyclic features in added dependency in `cargo add`. [#11805](https://github.com/rust-lang/cargo/pull/11805) -- Don't panic when [`patch`] involved in dependency resolution results in a conflict. +- Don't panic when `[patch]` involved in dependency resolution results in a conflict. [#11770](https://github.com/rust-lang/cargo/pull/11770) - Fixed credential token format validation. [#11951](https://github.com/rust-lang/cargo/pull/11951)