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.
This commit is contained in:
Eric Huss 2025-01-28 18:52:33 -08:00
parent e63457a4ce
commit 19b5e2356c
8 changed files with 12 additions and 6 deletions

View File

@ -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: |

View File

@ -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

View File

@ -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"

View File

@ -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/

View File

@ -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

View File

@ -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)

View File

@ -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.