From b472782d9d785d31586ab234f73231d3c937c82e Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 10:44:09 +0200 Subject: [PATCH 01/31] Add GitHub action to check links in Markdown files --- .github/workflows/action.yml | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 .github/workflows/action.yml diff --git a/.github/workflows/action.yml b/.github/workflows/action.yml new file mode 100644 index 0000000000000..7e75c6f3cbefe --- /dev/null +++ b/.github/workflows/action.yml @@ -0,0 +1,13 @@ +name: Check Markdown links + +on: push + +jobs: + markdown-link-check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - uses: gaurav-nelson/github-action-markdown-link-check@v1 + with: + use-quiet-mode: 'yes' + use-verbose-mode: 'yes' From 0253fe96b892b3b354372a7eb6cb142e0641e108 Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 10:51:09 +0200 Subject: [PATCH 02/31] Update action.yml --- .github/workflows/action.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/action.yml b/.github/workflows/action.yml index 7e75c6f3cbefe..a5eb2dec9d7fe 100644 --- a/.github/workflows/action.yml +++ b/.github/workflows/action.yml @@ -11,3 +11,4 @@ jobs: with: use-quiet-mode: 'yes' use-verbose-mode: 'yes' + config-file: 'mlc_config.json' From 62d623af2182646ad9bdb660f3d7624e733248c8 Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 10:52:15 +0200 Subject: [PATCH 03/31] Create mlc_config.json --- .github/workflows/mlc_config.json | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 .github/workflows/mlc_config.json diff --git a/.github/workflows/mlc_config.json b/.github/workflows/mlc_config.json new file mode 100644 index 0000000000000..37af26c7a6af2 --- /dev/null +++ b/.github/workflows/mlc_config.json @@ -0,0 +1,14 @@ +{ + "ignorePatterns": [ + { + "pattern": "^https?://" + } + ], + "replacementPatterns": [], + "httpHeaders": [], + "timeout": "20s", + "retryOn429": true, + "retryCount": 5, + "fallbackRetryDelay": "30s", + "aliveStatusCodes": [200, 206] +} From 9d0ebf4dd690382f41fa73a3574b05894f861102 Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 10:55:45 +0200 Subject: [PATCH 04/31] Update action.yml --- .github/workflows/action.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/action.yml b/.github/workflows/action.yml index a5eb2dec9d7fe..6030c4acc6117 100644 --- a/.github/workflows/action.yml +++ b/.github/workflows/action.yml @@ -11,4 +11,4 @@ jobs: with: use-quiet-mode: 'yes' use-verbose-mode: 'yes' - config-file: 'mlc_config.json' + config-file: '.github/workflows/mlc_config.json' From d5b7e80aa61adc60750e7a750dcb4e888727a8c9 Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 11:44:38 +0200 Subject: [PATCH 05/31] Pin version 1.0.12 of gaurav-nelson/github-action-markdown-link-check --- .github/workflows/action.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/action.yml b/.github/workflows/action.yml index 6030c4acc6117..c2b4aabc0de26 100644 --- a/.github/workflows/action.yml +++ b/.github/workflows/action.yml @@ -7,7 +7,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@master - - uses: gaurav-nelson/github-action-markdown-link-check@v1 + - uses: gaurav-nelson/github-action-markdown-link-check@0fe4911067fa322422f325b002d2038ba5602170 with: use-quiet-mode: 'yes' use-verbose-mode: 'yes' From ee66c17ddb9bb779eeaa8207532b81fbf3a00923 Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 13:55:43 +0200 Subject: [PATCH 06/31] Update mlc_config.json * Fix [404 on crates.io](https://github.com/rust-lang/crates.io/issues/788) * Only block external checks on github.com --- .github/workflows/mlc_config.json | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/.github/workflows/mlc_config.json b/.github/workflows/mlc_config.json index 37af26c7a6af2..0306abb619a9f 100644 --- a/.github/workflows/mlc_config.json +++ b/.github/workflows/mlc_config.json @@ -1,11 +1,18 @@ { "ignorePatterns": [ { - "pattern": "^https?://" + "pattern": "^https?://github.com/" } ], "replacementPatterns": [], - "httpHeaders": [], + "httpHeaders": [ + { + "urls": ["https://crates.io"], + "headers": { + "Accept": "text/html", + } + } + ], "timeout": "20s", "retryOn429": true, "retryCount": 5, From 7676dff0ea2c5596c2b65e494a130603770e2d80 Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 13:59:07 +0200 Subject: [PATCH 07/31] Update mlc_config.json --- .github/workflows/mlc_config.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/mlc_config.json b/.github/workflows/mlc_config.json index 0306abb619a9f..49378a36ce651 100644 --- a/.github/workflows/mlc_config.json +++ b/.github/workflows/mlc_config.json @@ -1,7 +1,7 @@ { "ignorePatterns": [ { - "pattern": "^https?://github.com/" + "pattern": "^https?://github\\.com/" } ], "replacementPatterns": [], @@ -9,7 +9,7 @@ { "urls": ["https://crates.io"], "headers": { - "Accept": "text/html", + "Accept": "text/html" } } ], From 11683894bebbae239065c0768eff9f59db0c95be Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 14:14:06 +0200 Subject: [PATCH 08/31] Add check-markdown-links to ci.yml --- .github/workflows/ci.yml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d1bcd4e3c4b3f..ab38a808a376b 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -93,6 +93,16 @@ jobs: # Not needed here as only one Linter is used. #GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + check-markdown-links: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: gaurav-nelson/github-action-markdown-link-check@0fe4911067fa322422f325b002d2038ba5602170 + with: + use-quiet-mode: 'yes' + use-verbose-mode: 'yes' + config-file: '.github/workflows/mlc_config.json' + run-examples: runs-on: ubuntu-latest From 1e41dc27b0f0a7742dc7d2baaa07a6b01c501568 Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 14:14:18 +0200 Subject: [PATCH 09/31] Delete action.yml --- .github/workflows/action.yml | 14 -------------- 1 file changed, 14 deletions(-) delete mode 100644 .github/workflows/action.yml diff --git a/.github/workflows/action.yml b/.github/workflows/action.yml deleted file mode 100644 index c2b4aabc0de26..0000000000000 --- a/.github/workflows/action.yml +++ /dev/null @@ -1,14 +0,0 @@ -name: Check Markdown links - -on: push - -jobs: - markdown-link-check: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@master - - uses: gaurav-nelson/github-action-markdown-link-check@0fe4911067fa322422f325b002d2038ba5602170 - with: - use-quiet-mode: 'yes' - use-verbose-mode: 'yes' - config-file: '.github/workflows/mlc_config.json' From db38b5a57b7024ea42a38e39177ca747d54f20ab Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 14:15:13 +0200 Subject: [PATCH 10/31] Add check-markdown-links to bors.toml --- .github/bors.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/bors.toml b/.github/bors.toml index 0e494d98c532f..d8997bc99f161 100644 --- a/.github/bors.toml +++ b/.github/bors.toml @@ -7,6 +7,7 @@ status = [ "build-wasm (nightly, ubuntu-latest)", "build-android", "markdownlint", + "check-markdown-links", "run-examples", "check-doc", ] From 1666502e6087e3bceb897e3d997947e14f27d7ea Mon Sep 17 00:00:00 2001 From: Oliver Becker Date: Sat, 1 May 2021 14:44:58 +0200 Subject: [PATCH 11/31] Moved markdown-link-check config --- .../mlc_config.json => linters/markdown-link-check.json} | 0 .github/workflows/ci.yml | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename .github/{workflows/mlc_config.json => linters/markdown-link-check.json} (100%) diff --git a/.github/workflows/mlc_config.json b/.github/linters/markdown-link-check.json similarity index 100% rename from .github/workflows/mlc_config.json rename to .github/linters/markdown-link-check.json diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index ab38a808a376b..5edfb19d50882 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -101,7 +101,7 @@ jobs: with: use-quiet-mode: 'yes' use-verbose-mode: 'yes' - config-file: '.github/workflows/mlc_config.json' + config-file: '.github/linters/markdown-link-check.json' run-examples: runs-on: ubuntu-latest From 8df3dd83416780be1bc6524fb85484e77a71f0e0 Mon Sep 17 00:00:00 2001 From: Oliver Becker Date: Sat, 1 May 2021 14:45:42 +0200 Subject: [PATCH 12/31] Ignore broken developer.android.com link in examples/README.md --- examples/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/examples/README.md b/examples/README.md index ef0687d5e9991..97d96a4545a6f 100644 --- a/examples/README.md +++ b/examples/README.md @@ -280,7 +280,9 @@ Please reference `cargo-apk` [README](https://crates.io/crates/cargo-apk) for ot ### Old phones -Bevy by default targets Android API level 29 in its examples which is the [Play Store's minimum API to upload or update apps](https://developer.android.com/distribute/best-practices/develop/target-sdk). Users of older phones may want to use an older API when testing. +Bevy by default targets Android API level 29 in its examples which is the +[Play Store's minimum API to upload or update apps](https://developer.android.com/distribute/best-practices/develop/target-sdk). +Users of older phones may want to use an older API when testing. To use a different API, the following fields must be updated in Cargo.toml: From 3c644bdcedfbaf3f1c27c3464990ed1a0a2cf2dd Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 18:26:49 +0000 Subject: [PATCH 13/31] Fix broken link to .markdown-lint.yml in docs/linters.md (#2065) --- docs/linters.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/linters.md b/docs/linters.md index 4a81da897c1a2..15f13b6b42d55 100644 --- a/docs/linters.md +++ b/docs/linters.md @@ -34,7 +34,7 @@ The provided rules are documented [here](https://github.com/DavidAnson/markdownl #### Using [VS Code markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) -If you want to use the VS Code Extension with the rules defined in [.markdown-lint.yml](../.github/linters/markdown-lint.yml), then you need to create a local config file in the root of the project with the configuration below. +If you want to use the VS Code Extension with the rules defined in [.markdown-lint.yml](../.github/linters/.markdown-lint.yml), then you need to create a local config file in the root of the project with the configuration below. Currently, this is not needed as the extension already disables the rule `MD013` by default. ```json From 4e5210f8e9f05a097025ed76c04652353e5f013e Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 18:51:54 +0000 Subject: [PATCH 14/31] Fix broken link to PBR example in README.md (#2064) --- examples/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/README.md b/examples/README.md index ef0687d5e9991..f52f72e9b5800 100644 --- a/examples/README.md +++ b/examples/README.md @@ -99,7 +99,7 @@ Example | File | Description `msaa` | [`3d/msaa.rs`](./3d/msaa.rs) | Configures MSAA (Multi-Sample Anti-Aliasing) for smoother edges `orthographic` | [`3d/orthographic.rs`](./3d/orthographic.rs) | Shows how to create a 3D orthographic view (for isometric-look games or CAD applications) `parenting` | [`3d/parenting.rs`](./3d/parenting.rs) | Demonstrates parent->child relationships and relative transformations -`pbr` | [`3d/pbr.rs`](./3d/[pbr].rs) | Demonstrates use of Physically Based Rendering (PBR) properties +`pbr` | [`3d/pbr.rs`](./3d/pbr.rs) | Demonstrates use of Physically Based Rendering (PBR) properties `render_to_texture` | [`3d/render_to_texture.rs`](./3d/render_to_texture.rs) | Shows how to render to texture `spawner` | [`3d/spawner.rs`](./3d/spawner.rs) | Renders a large number of cubes with changing position and material `texture` | [`3d/texture.rs`](./3d/texture.rs) | Shows configuration of texture materials From 82014a3abd0c1b5ee036606f422ee33cb4e1092e Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 18:51:55 +0000 Subject: [PATCH 15/31] Fix broken link to touch_input_events example (#2066) --- examples/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/README.md b/examples/README.md index f52f72e9b5800..af04087c28379 100644 --- a/examples/README.md +++ b/examples/README.md @@ -183,7 +183,7 @@ Example | File | Description `mouse_input` | [`input/mouse_input.rs`](./input/mouse_input.rs) | Demonstrates handling a mouse button press/release `mouse_input_events` | [`input/mouse_input_events.rs`](./input/mouse_input_events.rs) | Prints out all mouse events (buttons, movement, etc.) `touch_input` | [`input/touch_input.rs`](./input/touch_input.rs) | Displays touch presses, releases, and cancels -`touch_input_events` | [`input/touch_input_events.rs`](./input/touch_input_input_events.rs) | Prints out all touch inputs +`touch_input_events` | [`input/touch_input_events.rs`](./input/touch_input_events.rs) | Prints out all touch inputs ## Reflection From 5b8db27a254d5136729dfb43f2642175c2fc4b22 Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 18:26:49 +0000 Subject: [PATCH 16/31] Fix broken link to .markdown-lint.yml in docs/linters.md (#2065) --- docs/linters.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/linters.md b/docs/linters.md index 4a81da897c1a2..15f13b6b42d55 100644 --- a/docs/linters.md +++ b/docs/linters.md @@ -34,7 +34,7 @@ The provided rules are documented [here](https://github.com/DavidAnson/markdownl #### Using [VS Code markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) -If you want to use the VS Code Extension with the rules defined in [.markdown-lint.yml](../.github/linters/markdown-lint.yml), then you need to create a local config file in the root of the project with the configuration below. +If you want to use the VS Code Extension with the rules defined in [.markdown-lint.yml](../.github/linters/.markdown-lint.yml), then you need to create a local config file in the root of the project with the configuration below. Currently, this is not needed as the extension already disables the rule `MD013` by default. ```json From 0d5afeb9e32828ef49bda238cc8c03b8eebbf102 Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 18:51:54 +0000 Subject: [PATCH 17/31] Fix broken link to PBR example in README.md (#2064) --- examples/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/README.md b/examples/README.md index 97d96a4545a6f..75231ffecbe1a 100644 --- a/examples/README.md +++ b/examples/README.md @@ -99,7 +99,7 @@ Example | File | Description `msaa` | [`3d/msaa.rs`](./3d/msaa.rs) | Configures MSAA (Multi-Sample Anti-Aliasing) for smoother edges `orthographic` | [`3d/orthographic.rs`](./3d/orthographic.rs) | Shows how to create a 3D orthographic view (for isometric-look games or CAD applications) `parenting` | [`3d/parenting.rs`](./3d/parenting.rs) | Demonstrates parent->child relationships and relative transformations -`pbr` | [`3d/pbr.rs`](./3d/[pbr].rs) | Demonstrates use of Physically Based Rendering (PBR) properties +`pbr` | [`3d/pbr.rs`](./3d/pbr.rs) | Demonstrates use of Physically Based Rendering (PBR) properties `render_to_texture` | [`3d/render_to_texture.rs`](./3d/render_to_texture.rs) | Shows how to render to texture `spawner` | [`3d/spawner.rs`](./3d/spawner.rs) | Renders a large number of cubes with changing position and material `texture` | [`3d/texture.rs`](./3d/texture.rs) | Shows configuration of texture materials From e7ede2ed0d899524aec72993992fc7717c0fac6f Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 18:51:55 +0000 Subject: [PATCH 18/31] Fix broken link to touch_input_events example (#2066) --- examples/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/README.md b/examples/README.md index 75231ffecbe1a..096afc63e4193 100644 --- a/examples/README.md +++ b/examples/README.md @@ -183,7 +183,7 @@ Example | File | Description `mouse_input` | [`input/mouse_input.rs`](./input/mouse_input.rs) | Demonstrates handling a mouse button press/release `mouse_input_events` | [`input/mouse_input_events.rs`](./input/mouse_input_events.rs) | Prints out all mouse events (buttons, movement, etc.) `touch_input` | [`input/touch_input.rs`](./input/touch_input.rs) | Displays touch presses, releases, and cancels -`touch_input_events` | [`input/touch_input_events.rs`](./input/touch_input_input_events.rs) | Prints out all touch inputs +`touch_input_events` | [`input/touch_input_events.rs`](./input/touch_input_events.rs) | Prints out all touch inputs ## Reflection From 36e679cc3c9896bb11d41fd1ed703c1e5c4d6329 Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 10:44:09 +0200 Subject: [PATCH 19/31] Add GitHub action to check links in Markdown files --- .github/workflows/action.yml | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 .github/workflows/action.yml diff --git a/.github/workflows/action.yml b/.github/workflows/action.yml new file mode 100644 index 0000000000000..7e75c6f3cbefe --- /dev/null +++ b/.github/workflows/action.yml @@ -0,0 +1,13 @@ +name: Check Markdown links + +on: push + +jobs: + markdown-link-check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - uses: gaurav-nelson/github-action-markdown-link-check@v1 + with: + use-quiet-mode: 'yes' + use-verbose-mode: 'yes' From 822c3fa60fc3f314430b4250aaf7f1d2e3206ebd Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 10:51:09 +0200 Subject: [PATCH 20/31] Update action.yml --- .github/workflows/action.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/action.yml b/.github/workflows/action.yml index 7e75c6f3cbefe..a5eb2dec9d7fe 100644 --- a/.github/workflows/action.yml +++ b/.github/workflows/action.yml @@ -11,3 +11,4 @@ jobs: with: use-quiet-mode: 'yes' use-verbose-mode: 'yes' + config-file: 'mlc_config.json' From 045824548f69893580397387018707956f0b5469 Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 10:52:15 +0200 Subject: [PATCH 21/31] Create mlc_config.json --- .github/workflows/mlc_config.json | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 .github/workflows/mlc_config.json diff --git a/.github/workflows/mlc_config.json b/.github/workflows/mlc_config.json new file mode 100644 index 0000000000000..37af26c7a6af2 --- /dev/null +++ b/.github/workflows/mlc_config.json @@ -0,0 +1,14 @@ +{ + "ignorePatterns": [ + { + "pattern": "^https?://" + } + ], + "replacementPatterns": [], + "httpHeaders": [], + "timeout": "20s", + "retryOn429": true, + "retryCount": 5, + "fallbackRetryDelay": "30s", + "aliveStatusCodes": [200, 206] +} From d23997ea88843c56bceb0bda9c49d97ad1f4b28c Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 10:55:45 +0200 Subject: [PATCH 22/31] Update action.yml --- .github/workflows/action.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/action.yml b/.github/workflows/action.yml index a5eb2dec9d7fe..6030c4acc6117 100644 --- a/.github/workflows/action.yml +++ b/.github/workflows/action.yml @@ -11,4 +11,4 @@ jobs: with: use-quiet-mode: 'yes' use-verbose-mode: 'yes' - config-file: 'mlc_config.json' + config-file: '.github/workflows/mlc_config.json' From 75e58435839612bf001af4ad4f00cbd9addb5caa Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 11:44:38 +0200 Subject: [PATCH 23/31] Pin version 1.0.12 of gaurav-nelson/github-action-markdown-link-check --- .github/workflows/action.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/action.yml b/.github/workflows/action.yml index 6030c4acc6117..c2b4aabc0de26 100644 --- a/.github/workflows/action.yml +++ b/.github/workflows/action.yml @@ -7,7 +7,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@master - - uses: gaurav-nelson/github-action-markdown-link-check@v1 + - uses: gaurav-nelson/github-action-markdown-link-check@0fe4911067fa322422f325b002d2038ba5602170 with: use-quiet-mode: 'yes' use-verbose-mode: 'yes' From 606a826eab3c0f0605207afcc4bd6fe9482cde98 Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 13:55:43 +0200 Subject: [PATCH 24/31] Update mlc_config.json * Fix [404 on crates.io](https://github.com/rust-lang/crates.io/issues/788) * Only block external checks on github.com --- .github/workflows/mlc_config.json | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/.github/workflows/mlc_config.json b/.github/workflows/mlc_config.json index 37af26c7a6af2..0306abb619a9f 100644 --- a/.github/workflows/mlc_config.json +++ b/.github/workflows/mlc_config.json @@ -1,11 +1,18 @@ { "ignorePatterns": [ { - "pattern": "^https?://" + "pattern": "^https?://github.com/" } ], "replacementPatterns": [], - "httpHeaders": [], + "httpHeaders": [ + { + "urls": ["https://crates.io"], + "headers": { + "Accept": "text/html", + } + } + ], "timeout": "20s", "retryOn429": true, "retryCount": 5, From 626965523ec1822ce95942ac1cff30404b01b566 Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 13:59:07 +0200 Subject: [PATCH 25/31] Update mlc_config.json --- .github/workflows/mlc_config.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/mlc_config.json b/.github/workflows/mlc_config.json index 0306abb619a9f..49378a36ce651 100644 --- a/.github/workflows/mlc_config.json +++ b/.github/workflows/mlc_config.json @@ -1,7 +1,7 @@ { "ignorePatterns": [ { - "pattern": "^https?://github.com/" + "pattern": "^https?://github\\.com/" } ], "replacementPatterns": [], @@ -9,7 +9,7 @@ { "urls": ["https://crates.io"], "headers": { - "Accept": "text/html", + "Accept": "text/html" } } ], From 1d111b18b136b8ed6f8d76409587035c280c20c1 Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 14:14:06 +0200 Subject: [PATCH 26/31] Add check-markdown-links to ci.yml --- .github/workflows/ci.yml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d1bcd4e3c4b3f..ab38a808a376b 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -93,6 +93,16 @@ jobs: # Not needed here as only one Linter is used. #GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + check-markdown-links: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: gaurav-nelson/github-action-markdown-link-check@0fe4911067fa322422f325b002d2038ba5602170 + with: + use-quiet-mode: 'yes' + use-verbose-mode: 'yes' + config-file: '.github/workflows/mlc_config.json' + run-examples: runs-on: ubuntu-latest From 5facb6711c6eb5374cdeaeb5c527013ad942521c Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 14:14:18 +0200 Subject: [PATCH 27/31] Delete action.yml --- .github/workflows/action.yml | 14 -------------- 1 file changed, 14 deletions(-) delete mode 100644 .github/workflows/action.yml diff --git a/.github/workflows/action.yml b/.github/workflows/action.yml deleted file mode 100644 index c2b4aabc0de26..0000000000000 --- a/.github/workflows/action.yml +++ /dev/null @@ -1,14 +0,0 @@ -name: Check Markdown links - -on: push - -jobs: - markdown-link-check: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@master - - uses: gaurav-nelson/github-action-markdown-link-check@0fe4911067fa322422f325b002d2038ba5602170 - with: - use-quiet-mode: 'yes' - use-verbose-mode: 'yes' - config-file: '.github/workflows/mlc_config.json' From 7c42ec87e1b0ffce38a6c872c9571e9beef106e7 Mon Sep 17 00:00:00 2001 From: FlyingRatBull Date: Sat, 1 May 2021 14:15:13 +0200 Subject: [PATCH 28/31] Add check-markdown-links to bors.toml --- .github/bors.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/bors.toml b/.github/bors.toml index 0e494d98c532f..d8997bc99f161 100644 --- a/.github/bors.toml +++ b/.github/bors.toml @@ -7,6 +7,7 @@ status = [ "build-wasm (nightly, ubuntu-latest)", "build-android", "markdownlint", + "check-markdown-links", "run-examples", "check-doc", ] From 2c9bf3661a542ca92ec2ec5f66f15dc2f9f42af5 Mon Sep 17 00:00:00 2001 From: Oliver Becker Date: Sat, 1 May 2021 14:44:58 +0200 Subject: [PATCH 29/31] Moved markdown-link-check config --- .../mlc_config.json => linters/markdown-link-check.json} | 0 .github/workflows/ci.yml | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename .github/{workflows/mlc_config.json => linters/markdown-link-check.json} (100%) diff --git a/.github/workflows/mlc_config.json b/.github/linters/markdown-link-check.json similarity index 100% rename from .github/workflows/mlc_config.json rename to .github/linters/markdown-link-check.json diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index ab38a808a376b..5edfb19d50882 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -101,7 +101,7 @@ jobs: with: use-quiet-mode: 'yes' use-verbose-mode: 'yes' - config-file: '.github/workflows/mlc_config.json' + config-file: '.github/linters/markdown-link-check.json' run-examples: runs-on: ubuntu-latest From a5dac8e1995d739a523e64f21963c82483eeb39c Mon Sep 17 00:00:00 2001 From: Oliver Becker Date: Sat, 1 May 2021 14:45:42 +0200 Subject: [PATCH 30/31] Ignore broken developer.android.com link in examples/README.md --- examples/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/examples/README.md b/examples/README.md index af04087c28379..096afc63e4193 100644 --- a/examples/README.md +++ b/examples/README.md @@ -280,7 +280,9 @@ Please reference `cargo-apk` [README](https://crates.io/crates/cargo-apk) for ot ### Old phones -Bevy by default targets Android API level 29 in its examples which is the [Play Store's minimum API to upload or update apps](https://developer.android.com/distribute/best-practices/develop/target-sdk). Users of older phones may want to use an older API when testing. +Bevy by default targets Android API level 29 in its examples which is the +[Play Store's minimum API to upload or update apps](https://developer.android.com/distribute/best-practices/develop/target-sdk). +Users of older phones may want to use an older API when testing. To use a different API, the following fields must be updated in Cargo.toml: From 7d8ccea2ead071b34bfa5ebb013bfd7b364163b3 Mon Sep 17 00:00:00 2001 From: Oliver Becker Date: Sat, 1 May 2021 21:38:22 +0200 Subject: [PATCH 31/31] Fixed missing broken Markdown link --- docs/linters.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/linters.md b/docs/linters.md index 15f13b6b42d55..549bcb2b69462 100644 --- a/docs/linters.md +++ b/docs/linters.md @@ -28,7 +28,7 @@ Explanation: ### [markdownlint](https://github.com/DavidAnson/markdownlint) `markdownlint` is provided by `super-linter` and is responsible for `.md` files. -Its configuration is saved in the [.markdown-lint.yml](../.github/linters/markdown-lint.yml) file. +Its configuration is saved in the [.markdown-lint.yml](../.github/linters/.markdown-lint.yml) file. The provided rules are documented [here](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md) and information about setting the config can be seen [here](https://github.com/DavidAnson/markdownlint#optionsconfig).