From 377a1051aac8d63a55c7d9a57456a0fcc6e45081 Mon Sep 17 00:00:00 2001 From: Andreas Weibye Date: Sat, 13 Mar 2021 22:47:22 +0100 Subject: [PATCH 1/9] Fixing inconsistencies --- examples/README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/examples/README.md b/examples/README.md index 608f5ed5b09f0..e3b8878c136f0 100644 --- a/examples/README.md +++ b/examples/README.md @@ -72,7 +72,7 @@ git checkout v0.4.0 ## Hello, World! -Example | Main | Description +Example | File | Description --- | --- | --- `hello_world` | [`hello_world.rs`](./hello_world.rs) | Runs a minimal example that outputs "hello world" @@ -80,7 +80,7 @@ Example | Main | Description ## 2D Rendering -Example | Main | Description +Example | File | Description --- | --- | --- `contributors` | [`2d/contributors.rs`](./2d/contributors.rs) | Displays each contributor as a bouncy bevy-ball! `many_sprites` | [`2d/many_sprites.rs`](./2d/many_sprites.rs) | Displays many sprites in a grid arragement! Used for performance testing. @@ -197,10 +197,10 @@ Example | File | Description Example | File | Description --- | --- | --- -`reflection` | [`reflection/reflection.rs`](reflection/reflection.rs) | Demonstrates how reflection in Bevy provides a way to dynamically interact with Rust types -`generic_reflection` | [`reflection/generic_reflection.rs`](reflection/generic_reflection.rs) | Registers concrete instances of generic types that may be used with reflection -`reflection_types` | [`reflection/reflection_types.rs`](reflection/reflection_types.rs) | Illustrates the various reflection types available -`trait_reflection` | [`reflection/trait_reflection.rs`](reflection/trait_reflection.rs) | Allows reflection with trait objects +`reflection` | [`reflection/reflection.rs`](./reflection/reflection.rs) | Demonstrates how reflection in Bevy provides a way to dynamically interact with Rust types +`generic_reflection` | [`reflection/generic_reflection.rs`](./reflection/generic_reflection.rs) | Registers concrete instances of generic types that may be used with reflection +`reflection_types` | [`reflection/reflection_types.rs`](./reflection/reflection_types.rs) | Illustrates the various reflection types available +`trait_reflection` | [`reflection/trait_reflection.rs`](./reflection/trait_reflection.rs) | Allows reflection with trait objects ## Scene From 592e97d8f2b0f4e01850828ab5f1e2dd6e26b08d Mon Sep 17 00:00:00 2001 From: Andreas Weibye <13300393+Weibye@users.noreply.github.com> Date: Sat, 27 Mar 2021 18:19:28 +0100 Subject: [PATCH 2/9] Adding example checker action to repo --- .github/workflows/ci.yml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 661380e841c69..5045a06421b2c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -152,3 +152,17 @@ jobs: - name: Checks dead links run: cargo deadlinks --dir target/doc/bevy continue-on-error: true + + example-doc-validation: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Check that examples are present in both README and Cargo + uses: Weibye/action-internal-link-consistency@1.0.1 + with: + source: './examples/' + targets: '[ "./Cargo.toml", "./examples/README.md" ]' + file-types: '["rs"]' + exclude-folders: '["./examples/ios"]' + exclude-files: '[]' + \ No newline at end of file From 73386f6c8bcda0511b3d54fc4a69ec58069aa0d3 Mon Sep 17 00:00:00 2001 From: Andreas Weibye <13300393+Weibye@users.noreply.github.com> Date: Sat, 27 Mar 2021 21:24:01 +0100 Subject: [PATCH 3/9] Fixing typo --- .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 5045a06421b2c..33d1817cecc06 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -165,4 +165,4 @@ jobs: file-types: '["rs"]' exclude-folders: '["./examples/ios"]' exclude-files: '[]' - \ No newline at end of file + From 071a38bef551422e145961b2bddd62dc9eaef622 Mon Sep 17 00:00:00 2001 From: Andreas Weibye <13300393+Weibye@users.noreply.github.com> Date: Sat, 27 Mar 2021 18:19:28 +0100 Subject: [PATCH 4/9] Minor cleanup --- .github/workflows/ci.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 33d1817cecc06..fe219d784475c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -165,4 +165,3 @@ jobs: file-types: '["rs"]' exclude-folders: '["./examples/ios"]' exclude-files: '[]' - From ddb17504b728821e79f4f219e3640b6e2d67bf05 Mon Sep 17 00:00:00 2001 From: Andreas Weibye <13300393+Weibye@users.noreply.github.com> Date: Fri, 28 May 2021 21:41:16 +0200 Subject: [PATCH 5/9] Updating action version --- .github/workflows/ci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index fe219d784475c..4b8a32ba1023e 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -158,10 +158,10 @@ jobs: steps: - uses: actions/checkout@v2 - name: Check that examples are present in both README and Cargo - uses: Weibye/action-internal-link-consistency@1.0.1 + uses: Weibye/action-internal-link-consistency@1.1.0 with: source: './examples/' targets: '[ "./Cargo.toml", "./examples/README.md" ]' - file-types: '["rs"]' + file-types: '[".rs"]' exclude-folders: '["./examples/ios"]' exclude-files: '[]' From a10566d2dc5ba1641b4b62f05a62b08fe8890110 Mon Sep 17 00:00:00 2001 From: Andreas Weibye <13300393+Weibye@users.noreply.github.com> Date: Sat, 29 May 2021 11:40:22 +0200 Subject: [PATCH 6/9] Added to bors --- .github/bors.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/bors.toml b/.github/bors.toml index d8997bc99f161..b430c6f73e1c3 100644 --- a/.github/bors.toml +++ b/.github/bors.toml @@ -10,6 +10,7 @@ status = [ "check-markdown-links", "run-examples", "check-doc", + "example-doc-validation", ] use_squash_merge = true From d2c0a42d49ca8a81fc9340ddab538ff3322d4c48 Mon Sep 17 00:00:00 2001 From: Andreas Weibye <13300393+Weibye@users.noreply.github.com> Date: Sat, 29 May 2021 14:33:17 +0200 Subject: [PATCH 7/9] Using fixed version of action --- .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 4b8a32ba1023e..d33ce2c54daa6 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -158,7 +158,7 @@ jobs: steps: - uses: actions/checkout@v2 - name: Check that examples are present in both README and Cargo - uses: Weibye/action-internal-link-consistency@1.1.0 + uses: Weibye/action-internal-link-consistency@1.1.1 with: source: './examples/' targets: '[ "./Cargo.toml", "./examples/README.md" ]' From e5eeafda6cfef33e678f6f778477d5753e234af8 Mon Sep 17 00:00:00 2001 From: Andreas Weibye <13300393+Weibye@users.noreply.github.com> Date: Sun, 30 May 2021 15:58:22 +0200 Subject: [PATCH 8/9] Renaming action --- .github/bors.toml | 2 +- .github/workflows/ci.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/bors.toml b/.github/bors.toml index b430c6f73e1c3..20c21ea828158 100644 --- a/.github/bors.toml +++ b/.github/bors.toml @@ -10,7 +10,7 @@ status = [ "check-markdown-links", "run-examples", "check-doc", - "example-doc-validation", + "check-missing-examples-in-docs", ] use_squash_merge = true diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d33ce2c54daa6..d8b12dbb57fd8 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -153,7 +153,7 @@ jobs: run: cargo deadlinks --dir target/doc/bevy continue-on-error: true - example-doc-validation: + check-missing-examples-in-docs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 From 794f078fd00a3550f82ab71659d4cde33d339a7e Mon Sep 17 00:00:00 2001 From: Andreas Weibye <13300393+Weibye@users.noreply.github.com> Date: Sun, 30 May 2021 15:58:58 +0200 Subject: [PATCH 9/9] Adjusting to new action versioning --- .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 d8b12dbb57fd8..63a34cebab868 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -158,7 +158,7 @@ jobs: steps: - uses: actions/checkout@v2 - name: Check that examples are present in both README and Cargo - uses: Weibye/action-internal-link-consistency@1.1.1 + uses: Weibye/action-internal-link-consistency@1.0.0 with: source: './examples/' targets: '[ "./Cargo.toml", "./examples/README.md" ]'