From 24d50b4b215c2f14986031dde3f39dda3938b214 Mon Sep 17 00:00:00 2001 From: mnmaita <47983254+mnmaita@users.noreply.github.com> Date: Sun, 7 Mar 2021 14:14:57 -0300 Subject: [PATCH 1/7] Adds docs deadlinks check on CI --- .github/workflows/ci.yml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 210be5dfe410c..1d9ea71462527 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -92,3 +92,11 @@ jobs: DEFAULT_BRANCH: master # Not needed here as only one Linter is used. #GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + deadlinks: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Checks dead doc links + run: cargo install cargo-deadlinks + run: cargo deadlinks From 1a97eb85e355d272b877c2c415c482f815ddd8d4 Mon Sep 17 00:00:00 2001 From: mnmaita <47983254+mnmaita@users.noreply.github.com> Date: Sun, 7 Mar 2021 14:29:16 -0300 Subject: [PATCH 2/7] Fixes CI script --- .github/workflows/ci.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 1d9ea71462527..8b81005aab623 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -97,6 +97,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - name: Checks dead doc links + - name: Installs cargo-deadlinks run: cargo install cargo-deadlinks + - name: Checks dead doc links run: cargo deadlinks From 084674ffa8d28c6ebb0ca33bec33566eec64c331 Mon Sep 17 00:00:00 2001 From: mnmaita <47983254+mnmaita@users.noreply.github.com> Date: Sun, 7 Mar 2021 15:01:24 -0300 Subject: [PATCH 3/7] Installs Linux build deps --- .github/workflows/ci.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 8b81005aab623..6f1bfaf2edc89 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -97,6 +97,9 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 + - name: Install alsa and udev + run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev + if: runner.os == 'linux' - name: Installs cargo-deadlinks run: cargo install cargo-deadlinks - name: Checks dead doc links From 8bde29486ebe457c2f6b4ed6a502267ebc6de3db Mon Sep 17 00:00:00 2001 From: mnmaita <47983254+mnmaita@users.noreply.github.com> Date: Sun, 7 Mar 2021 21:40:05 -0300 Subject: [PATCH 4/7] Prevents deadlinks check from failing This will make the job a source of information on which links are broken, since a considerable amount is missing from the docs. --- .github/workflows/ci.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 6f1bfaf2edc89..04ded2f710e6d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -104,3 +104,4 @@ jobs: run: cargo install cargo-deadlinks - name: Checks dead doc links run: cargo deadlinks + continue-on-error: true From fb79f461680486c922579d9b0c3e661895317ab7 Mon Sep 17 00:00:00 2001 From: mnmaita <47983254+mnmaita@users.noreply.github.com> Date: Mon, 8 Mar 2021 23:28:42 -0300 Subject: [PATCH 5/7] Runs cargo deadlinks only on bevy docs folder --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 04ded2f710e6d..6ecc48b419bbb 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -103,5 +103,5 @@ jobs: - name: Installs cargo-deadlinks run: cargo install cargo-deadlinks - name: Checks dead doc links - run: cargo deadlinks + run: cargo doc --all-features && cargo deadlinks --dir target/doc/bevy continue-on-error: true From 5808021556e3b515ad071d9eeef53e44635aafff Mon Sep 17 00:00:00 2001 From: mnmaita <47983254+mnmaita@users.noreply.github.com> Date: Mon, 19 Apr 2021 20:34:55 -0300 Subject: [PATCH 6/7] Ignores dependencies when building docs --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index aaf06f923bf94..cd6b5b0f36487 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -139,5 +139,5 @@ jobs: - name: Installs cargo-deadlinks run: cargo install cargo-deadlinks - name: Checks dead doc links - run: cargo doc --all-features && cargo deadlinks --dir target/doc/bevy + run: cargo doc --no-deps && cargo deadlinks --dir target/doc/bevy continue-on-error: true From 30126163dd86de427c6b4a113c93873dabc56e37 Mon Sep 17 00:00:00 2001 From: mnmaita <47983254+mnmaita@users.noreply.github.com> Date: Mon, 19 Apr 2021 20:38:33 -0300 Subject: [PATCH 7/7] Restores --all-features argument --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index cd6b5b0f36487..80d5e55333e05 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -139,5 +139,5 @@ jobs: - name: Installs cargo-deadlinks run: cargo install cargo-deadlinks - name: Checks dead doc links - run: cargo doc --no-deps && cargo deadlinks --dir target/doc/bevy + run: cargo doc --all-features --no-deps && cargo deadlinks --dir target/doc/bevy continue-on-error: true