From 01e4e0570cb59e755afa7d3a7d1d9861f49e4fc7 Mon Sep 17 00:00:00 2001 From: Andreas Reich Date: Thu, 24 Oct 2024 11:56:27 +0200 Subject: [PATCH 1/5] link checker now runs with reported failures if a markdown changes or on nightly channel --- .github/workflows/reusable_checks.yml | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/.github/workflows/reusable_checks.yml b/.github/workflows/reusable_checks.yml index dd93bfa57c51..e75a814c7b99 100644 --- a/.github/workflows/reusable_checks.yml +++ b/.github/workflows/reusable_checks.yml @@ -161,8 +161,25 @@ jobs: # --------------------------------------------------------------------------- + markdown-paths-filter: + runs-on: ubuntu-latest + outputs: + md_changes: ${{ steps.filter.outputs.md_changes }} + steps: + - uses: actions/checkout@v4 + with: + ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.ref || '' }} + - uses: dorny/paths-filter@v3 + id: filter + with: + filters: | + md_changes: + - '**/*.md' + link-checker: name: Check links + needs: markdown-paths-filter + if: inputs.CHANNEL == 'nightly' || needs.markdown-paths-filter.outputs.md_changes == 'true' runs-on: ubuntu-latest # do not fail entire workflow (e.g. nightly) if this is the only failing check continue-on-error: true @@ -174,7 +191,6 @@ jobs: id: lychee uses: lycheeverse/lychee-action@v1.10.0 with: - fail: ${{ inputs.CHANNEL == 'nightly' }} lycheeVersion: "0.15.1" # When given a directory, lychee checks only markdown, html and text files, everything else we have to glob in manually. # Pass --verbose, so that all considered links are printed, making it easier to debug. From e5f2dc9e60f4b23dea00c027000f1b5328945a47 Mon Sep 17 00:00:00 2001 From: Andreas Reich Date: Thu, 24 Oct 2024 11:58:19 +0200 Subject: [PATCH 2/5] change a markdown file --- docs/content/getting-started/data-in/cpp.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/content/getting-started/data-in/cpp.md b/docs/content/getting-started/data-in/cpp.md index 5c110fd0113f..56f17fda06cb 100644 --- a/docs/content/getting-started/data-in/cpp.md +++ b/docs/content/getting-started/data-in/cpp.md @@ -190,6 +190,8 @@ Notably, the [`RecordingStream::log`](https://github.com/rerun-io/rerun/blob/d96 will handle any data type that implements the [`AsComponents`](https://github.com/rerun-io/rerun/blob/latest/rerun_cpp/src/rerun/as_components.hpp) trait, making it easy to add your own data. For more information on how to supply your own components see [Use custom data](../../howto/extend/custom-data.md). +TODO: test change! + ### Entities & hierarchies Note the two strings we're passing in: `"dna/structure/left"` and `"dna/structure/right"`. From 8af89456a53a66062f91743fb3b8059ad7ebd335 Mon Sep 17 00:00:00 2001 From: Andreas Reich Date: Thu, 24 Oct 2024 12:00:54 +0200 Subject: [PATCH 3/5] =?UTF-8?q?disable=20`continue-on-error`=20since=20tha?= =?UTF-8?q?t=20seems=20to=20remove=20the=20=E2=9D=8C=20on=20github?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/reusable_checks.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/reusable_checks.yml b/.github/workflows/reusable_checks.yml index e75a814c7b99..63426cb3007e 100644 --- a/.github/workflows/reusable_checks.yml +++ b/.github/workflows/reusable_checks.yml @@ -181,8 +181,6 @@ jobs: needs: markdown-paths-filter if: inputs.CHANNEL == 'nightly' || needs.markdown-paths-filter.outputs.md_changes == 'true' runs-on: ubuntu-latest - # do not fail entire workflow (e.g. nightly) if this is the only failing check - continue-on-error: true steps: - uses: actions/checkout@v4 From 814b27397b74213cb16239c37bf62c4a5153b643 Mon Sep 17 00:00:00 2001 From: Andreas Reich Date: Thu, 24 Oct 2024 12:03:44 +0200 Subject: [PATCH 4/5] try instead to set fail == true --- .github/workflows/reusable_checks.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/reusable_checks.yml b/.github/workflows/reusable_checks.yml index 63426cb3007e..530c1b73712e 100644 --- a/.github/workflows/reusable_checks.yml +++ b/.github/workflows/reusable_checks.yml @@ -181,6 +181,8 @@ jobs: needs: markdown-paths-filter if: inputs.CHANNEL == 'nightly' || needs.markdown-paths-filter.outputs.md_changes == 'true' runs-on: ubuntu-latest + # do not fail entire workflow (e.g. nightly) if this is the only failing check + continue-on-error: true steps: - uses: actions/checkout@v4 @@ -189,6 +191,7 @@ jobs: id: lychee uses: lycheeverse/lychee-action@v1.10.0 with: + fail: true lycheeVersion: "0.15.1" # When given a directory, lychee checks only markdown, html and text files, everything else we have to glob in manually. # Pass --verbose, so that all considered links are printed, making it easier to debug. From 4f29bff925eb4e4881aea8d0f0149ccc4f38a5ee Mon Sep 17 00:00:00 2001 From: Andreas Reich Date: Thu, 24 Oct 2024 12:05:22 +0200 Subject: [PATCH 5/5] undo markdown change --- docs/content/getting-started/data-in/cpp.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/content/getting-started/data-in/cpp.md b/docs/content/getting-started/data-in/cpp.md index 56f17fda06cb..5c110fd0113f 100644 --- a/docs/content/getting-started/data-in/cpp.md +++ b/docs/content/getting-started/data-in/cpp.md @@ -190,8 +190,6 @@ Notably, the [`RecordingStream::log`](https://github.com/rerun-io/rerun/blob/d96 will handle any data type that implements the [`AsComponents`](https://github.com/rerun-io/rerun/blob/latest/rerun_cpp/src/rerun/as_components.hpp) trait, making it easy to add your own data. For more information on how to supply your own components see [Use custom data](../../howto/extend/custom-data.md). -TODO: test change! - ### Entities & hierarchies Note the two strings we're passing in: `"dna/structure/left"` and `"dna/structure/right"`.