Skip to content

Commit

Permalink
Standardize rust docs args and use of RUSTC_BOOTSTRAP (#2120)
Browse files Browse the repository at this point in the history
# 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
  • Loading branch information
wilwade authored Aug 12, 2024
1 parent de0d9c8 commit 29a85e3
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 11 deletions.
4 changes: 1 addition & 3 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -348,9 +348,7 @@ jobs:
uses: actions/configure-pages@v5
- name: Build Docs
run: |
rustup target add wasm32-unknown-unknown --toolchain nightly-2024-08-01
rustup component add rust-src --toolchain nightly-2024-08-01
RUSTDOCFLAGS="--enable-index-page -Zunstable-options" cargo +nightly-2024-08-01 doc --no-deps --workspace --features frequency
RUSTC_BOOTSTRAP=1 RUSTDOCFLAGS="--enable-index-page -Zunstable-options" cargo doc --no-deps --workspace --features frequency
- name: Fix file permissions
shell: sh
run: |
Expand Down
8 changes: 1 addition & 7 deletions .github/workflows/verify-pr-commit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -236,15 +236,9 @@ jobs:
steps:
- name: Check Out Repo
uses: actions/checkout@v4
- name: Install Nightly Toolchain
run: rustup toolchain install nightly-2024-08-01
- name: Add Required Components
run: |
rustup target add wasm32-unknown-unknown --toolchain nightly-2024-08-01
rustup component add rust-src --toolchain nightly-2024-08-01
- name: Build Docs
run: |
RUSTDOCFLAGS="--enable-index-page --check -Zunstable-options" cargo +nightly-2024-08-01 doc --no-deps --features frequency
RUSTC_BOOTSTRAP=1 RUSTDOCFLAGS="--enable-index-page --check -Zunstable-options" cargo doc --no-deps --workspace --features frequency
verify-rust-packages-and-deps:
needs: changes
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ benchmarks-capacity:

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

# Cleans unused docker resources and artifacts
.PHONY: docs
Expand Down

0 comments on commit 29a85e3

Please sign in to comment.