Skip to content

Commit 19b5e23

Browse files
committed
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.
1 parent e63457a commit 19b5e23

File tree

8 files changed

+12
-6
lines changed

8 files changed

+12
-6
lines changed

.github/workflows/contrib.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323
- name: Install mdbook
2424
run: |
2525
mkdir mdbook
26-
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
26+
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
2727
echo `pwd`/mdbook >> $GITHUB_PATH
2828
- name: Deploy docs
2929
run: |

.github/workflows/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ jobs:
261261
- name: Install mdbook
262262
run: |
263263
mkdir mdbook
264-
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
264+
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
265265
echo `pwd`/mdbook >> $GITHUB_PATH
266266
- run: cd src/doc && mdbook build --dest-dir ../../target/doc
267267
- name: Run linkchecker.sh

src/doc/book.toml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,12 @@ author = "Alex Crichton, Steve Klabnik and Carol Nichols, with contributions fro
66
smart-punctuation = true # Enable smart-punctuation feature for more than quotes.
77
git-repository-url = "https://github.com/rust-lang/cargo/tree/master/src/doc/src"
88
edit-url-template = "https://github.com/rust-lang/cargo/edit/master/src/doc/{path}"
9-
search.use-boolean-and = true
9+
10+
[output.html.search]
11+
use-boolean-and = true
12+
13+
[output.html.search.chapter]
14+
"CHANGELOG.md" = { enable = false }
1015

1116
[output.html.redirect]
1217
"/guide/build-cache.html" = "../reference/build-cache.html"

src/doc/contrib/src/process/release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ The process here is similar to the beta-backporting process. The
183183
[choochoo]: https://doc.rust-lang.org/book/appendix-07-nightly-rust.html
184184
[rust-lang/rust]: https://github.com/rust-lang/rust/
185185
[rust-lang/cargo]: https://github.com/rust-lang/cargo/
186-
[CHANGELOG]: https://github.com/rust-lang/cargo/blob/master/CHANGELOG.md
186+
[CHANGELOG]: https://github.com/rust-lang/cargo/blob/master/src/doc/src/CHANGELOG.md
187187
[release process]: https://forge.rust-lang.org/release/process.html
188188
[`TargetInfo`]: https://github.com/rust-lang/cargo/blob/master/src/cargo/core/compiler/build_context/target_info.rs
189189
[crates.io]: https://crates.io/

src/doc/contrib/src/process/security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,6 @@ Post release:
131131
[GHSA-r5w3-xm58-jv6j]: https://github.com/rust-lang/cargo/security/advisories/GHSA-r5w3-xm58-jv6j
132132
[handling reports]: https://github.com/rust-lang/wg-security-response/blob/main/docs/handling-reports.md
133133
[first-guide]: https://www.first.org/cvss/user-guide
134-
[`CHANGELOG.md`]: https://github.com/rust-lang/cargo/blob/master/CHANGELOG.md
134+
[`CHANGELOG.md`]: https://github.com/rust-lang/cargo/blob/master/src/doc/src/CHANGELOG.md
135135
[`Cargo.toml`]: https://github.com/rust-lang/cargo/blob/master/Cargo.toml
136136
[`RELEASES.md`]: https://github.com/rust-lang/rust/blob/master/RELEASES.md
File renamed without changes.

src/doc/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,5 +97,6 @@
9797
* [Deprecated and Removed](commands/deprecated-and-removed.md)
9898

9999
* [FAQ](faq.md)
100+
* [Changelog](CHANGELOG.md)
100101
* [Appendix: Glossary](appendix/glossary.md)
101102
* [Appendix: Git Authentication](appendix/git-authentication.md)

src/doc/src/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The commands will let you interact with Cargo using its command-line interface.
3434
* [Git Authentication](appendix/git-authentication.md)
3535

3636
**Other Documentation:**
37-
* [Changelog](https://github.com/rust-lang/cargo/blob/master/CHANGELOG.md)
37+
* [Changelog](CHANGELOG.md)
3838
--- Detailed notes about changes in Cargo in each release.
3939
* [Rust documentation website](https://doc.rust-lang.org/) --- Links to official
4040
Rust documentation and tools.

0 commit comments

Comments
 (0)