Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Fail docs on warnings #5923

Merged
merged 34 commits into from
Sep 11, 2020
Merged
Changes from 4 commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
4261659
change (ci): docs job optimized; runs every commit; fails on warnings
TriplEight May 6, 2020
d5d0df9
change (ci): rename jobs; temporary allow failing
TriplEight May 6, 2020
e3dc50f
change (ci): better warnings filtering
TriplEight May 6, 2020
4ac187c
Merge branch 'master' into docs_deny_warnings
TriplEight May 8, 2020
237d83f
fix (ci): hotfix Docker release
TriplEight May 11, 2020
5682836
Merge branch 'master' of github.com:paritytech/substrate
TriplEight May 11, 2020
38fa585
Merge branch 'master' of github.com:paritytech/substrate
TriplEight May 15, 2020
af4ee4b
Merge branch 'master' of github.com:paritytech/substrate
TriplEight May 15, 2020
bec6eba
Merge branch 'master' of github.com:paritytech/substrate
TriplEight May 16, 2020
9247a3f
Merge branch 'master' of github.com:paritytech/substrate
TriplEight May 27, 2020
b9d7f01
Merge branch 'master' of github.com:paritytech/substrate
TriplEight May 27, 2020
d0ab2b4
Merge branch 'master' of github.com:paritytech/substrate
TriplEight Jun 2, 2020
362dfd8
Merge branch 'master' into docs_deny_warnings
TriplEight Jun 2, 2020
762b10a
test (ci): run docs job with flags
TriplEight Jun 2, 2020
0a9ffe9
test (ci): pwd fails
TriplEight Jun 2, 2020
43b024a
change (ci): pass just //doc dir as an artifact; debug
TriplEight Jun 2, 2020
427fe2e
change (ci): return to the previous structure; undebug
TriplEight Jun 2, 2020
72cdab2
Merge branch 'master' of github.com:paritytech/substrate
TriplEight Jun 2, 2020
0389d95
Merge branch 'master' into docs_deny_warnings
TriplEight Jun 2, 2020
450961c
change (ci): typo
TriplEight Jun 2, 2020
fd7352b
Merge branch 'master' into docs_deny_warnings
TriplEight Jun 10, 2020
08d4686
rebase on upstream
TriplEight Sep 9, 2020
4fd1949
rebase on upstream 2
TriplEight Sep 9, 2020
a559a34
fix the jobname
TriplEight Sep 9, 2020
b7be4f1
Fix some warnings (#7079)
danforbes Sep 10, 2020
93c92bf
Merge branch 'master' into docs_deny_warnings
bkchr Sep 10, 2020
feb1f47
Fix more doc errors
bkchr Sep 10, 2020
84d41a5
More doc fixes
bkchr Sep 11, 2020
def5e3a
Remove subdb to make `rustdoc` happy
bkchr Sep 11, 2020
bf5adbf
Make the line length check happy
bkchr Sep 11, 2020
e32d619
Fix compilation error
bkchr Sep 11, 2020
9bfb811
Another try
bkchr Sep 11, 2020
135e579
Allow unused
bkchr Sep 11, 2020
120c22b
Merge remote-tracking branch 'origin/master' into docs_deny_warnings
bkchr Sep 11, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# image: parity/tools:latest # Any docker image (required)
# allow_failure: true # Allow the pipeline to continue if this job fails (default: false)
# dependencies:
# - build-rust-doc-release # Any jobs that are required to run before this job (optional)
# - build-rust-doc # Any jobs that are required to run before this job (optional)
# variables:
# MY_ENVIRONMENT_VARIABLE: "some useful value" # Environment variables passed to the job (optional)
# script:
Expand Down Expand Up @@ -426,21 +426,29 @@ build-macos-subkey:
tags:
- osx

build-rust-doc-release:
build-rust-doc:
stage: build
<<: *docker-env
# FIXME: remove after the docs get fixed
allow_failure: true
artifacts:
name: "${CI_JOB_NAME}_${CI_COMMIT_REF_NAME}-doc"
when: on_success
expire_in: 7 days
paths:
- ./crate-docs
<<: *build-only
script:
- rm -f ./crate-docs/index.html # use it as an indicator if the job succeeds
- BUILD_DUMMY_WASM_BINARY=1 RUSTDOCFLAGS="--html-in-header $(pwd)/.maintain/rustdoc-header.html" time cargo +nightly doc --release --all --verbose
- cp -R ./target/doc ./crate-docs
- BUILD_DUMMY_WASM_BINARY=1 RUSTDOCFLAGS="--html-in-header $(pwd)/.maintain/rustdoc-header.html"
time cargo +nightly doc --no-deps --workspace --all-features --verbose --target-dir ./crate-docs |& tee output.log
- echo "____Docs job successful, checking for warnings____"
- sed -n '/^warning:/,/^$/p' output.log > ${CI_COMMIT_SHORT_SHA}_warnings.log
- if [ -s ${CI_COMMIT_SHORT_SHA}_warnings.log ]; then
cat ${CI_COMMIT_SHORT_SHA}_warnings.log;
exit 1;
else
echo "___No warnings___";
fi
- echo "<meta http-equiv=refresh content=0;url=sc_service/index.html>" > ./crate-docs/index.html
- sccache -s

Expand Down Expand Up @@ -556,7 +564,7 @@ publish-s3-doc:
image: parity/awscli:latest
allow_failure: true
dependencies:
- build-rust-doc-release
- build-rust-doc
cache: {}
<<: *build-only
<<: *kubernetes-build
Expand Down