Skip to content

Commit 29a85e3

Browse files
authored
Standardize rust docs args and use of RUSTC_BOOTSTRAP (#2120)
# Goal The goal of this PR is to fix an issue with the last RC release attempt: https://github.com/frequency-chain/frequency/actions/runs/10324779461 # Discussion - `RUSTC_BOOTSTRAP` turns "stable" rust into "nightly" - We were using this before in places, but not consistently across all the workflows - This correctly updates everything to use it and all to use the consistent parameters ## Verify Locally run the `make docs` or `RUSTC_BOOTSTRAP=1 RUSTDOCFLAGS="--enable-index-page -Zunstable-options" cargo doc --no-deps --workspace --features frequency` command
1 parent de0d9c8 commit 29a85e3

File tree

3 files changed

+3
-11
lines changed

3 files changed

+3
-11
lines changed

.github/workflows/release.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -348,9 +348,7 @@ jobs:
348348
uses: actions/configure-pages@v5
349349
- name: Build Docs
350350
run: |
351-
rustup target add wasm32-unknown-unknown --toolchain nightly-2024-08-01
352-
rustup component add rust-src --toolchain nightly-2024-08-01
353-
RUSTDOCFLAGS="--enable-index-page -Zunstable-options" cargo +nightly-2024-08-01 doc --no-deps --workspace --features frequency
351+
RUSTC_BOOTSTRAP=1 RUSTDOCFLAGS="--enable-index-page -Zunstable-options" cargo doc --no-deps --workspace --features frequency
354352
- name: Fix file permissions
355353
shell: sh
356354
run: |

.github/workflows/verify-pr-commit.yml

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -236,15 +236,9 @@ jobs:
236236
steps:
237237
- name: Check Out Repo
238238
uses: actions/checkout@v4
239-
- name: Install Nightly Toolchain
240-
run: rustup toolchain install nightly-2024-08-01
241-
- name: Add Required Components
242-
run: |
243-
rustup target add wasm32-unknown-unknown --toolchain nightly-2024-08-01
244-
rustup component add rust-src --toolchain nightly-2024-08-01
245239
- name: Build Docs
246240
run: |
247-
RUSTDOCFLAGS="--enable-index-page --check -Zunstable-options" cargo +nightly-2024-08-01 doc --no-deps --features frequency
241+
RUSTC_BOOTSTRAP=1 RUSTDOCFLAGS="--enable-index-page --check -Zunstable-options" cargo doc --no-deps --workspace --features frequency
248242
249243
verify-rust-packages-and-deps:
250244
needs: changes

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ benchmarks-capacity:
196196

197197
.PHONY: docs
198198
docs:
199-
RUSTC_BOOTSTRAP=1 RUSTDOCFLAGS="--enable-index-page -Zunstable-options" cargo doc --no-deps --features frequency
199+
RUSTC_BOOTSTRAP=1 RUSTDOCFLAGS="--enable-index-page -Zunstable-options" cargo doc --no-deps --workspace --features frequency
200200

201201
# Cleans unused docker resources and artifacts
202202
.PHONY: docs

0 commit comments

Comments
 (0)