Build the docs with test.sh #858
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The test script is incorrectly named in our contributor docs. Fix it up with the correct name.
Kixunil
reviewed
Mar 8, 2022
tcharding
force-pushed
the
850-test-script
branch
from
034d451
to
b353e35
Compare
|
Oh yes, cheers, that is much better. I'll patch |
|
Changes in force-push:
Also re-worded PR description. |
tcharding
force-pushed
the
850-test-script
branch
from
b353e35
to
140840d
Compare
Some code has only two spaces of indentation, we favour 4 in bash scripts.
We currently build the docs as a separate CI job, we can however just do it as part of the `Tests` job using the nightly toolchain. Conditionally build the docs based on a `DO_DOCS` env var. Note, uses `--cfg docsrs` so can only be built run with nightly toolchain.
tcharding
force-pushed
the
850-test-script
branch
from
140840d
to
0d36455
Compare
|
Changes in rebase: Remove the pinning changes because they were incorrect (and not anything to do with this PR). |
Kixunil
approved these changes
Mar 9, 2022
apoelstra
added a commit
to rust-bitcoin/rust-secp256k1
that referenced
this pull request
Mar 9, 2022
0fd07ad Improve CI pipeline (Tobin Harding) Pull request description: We have unnecessary runs of the `test.sh` script. We can simplify the CI pipeline and at the same time improve the docs build by using `--cfg docsrs`. - Remove the `wasm` job, replace it by enabling the `DO_WASM` env var for the stable toolchain run in the `Tests` job. - Add `--cfg docrs` flag to the docs build and set the `DO_DOCS` env var as part of the nightly toolchain run in `Tests` job. The end result is one less run of the `test.sh` script and better test coverage. Idea came from @Kixunil when reviewing rust-bitcoin/rust-bitcoin#858, thanks. ACKs for top commit: apoelstra: ACK 0fd07ad Tree-SHA512: 063493ce03aa8cef5d7fc7636f3bfaaeff5c918d7076473bac23313082e8357d5282fcaf4d76a3dc5b0650e7ee43fa9d2b738f79863be7f24f2acf32f99da4b1
apoelstra
approved these changes
Mar 9, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We currently build the docs as a separate CI job, we can however just do it as part of the
Testsjob using the nightly toolchain.Conditionally build the docs based on a
DO_DOCSenv var.Note, uses
--cfg docsrsso can only be built run with nightly toolchain.ci.sh->test.shinCONTRIBUTING.md.test.sh.Resolves: #850