This is an automated email from the ASF dual-hosted git repository.
guanmingchiu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/mahout.git
The following commit(s) were added to refs/heads/main by this push:
new b7b10dfbf ci: lychee to check broken links (#1145)
b7b10dfbf is described below
commit b7b10dfbf56e2d91f26753a60fb126a098168acc
Author: Tim Hsiung <[email protected]>
AuthorDate: Sun Mar 8 16:27:17 2026 +0800
ci: lychee to check broken links (#1145)
---
.github/workflows/links.yml | 44 ++++++++++++++++++++++++++++++++++++++++++++
docs/qdp/getting-started.md | 6 +++---
lychee.toml | 10 ++++++++++
3 files changed, 57 insertions(+), 3 deletions(-)
diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml
new file mode 100644
index 000000000..9ddfce681
--- /dev/null
+++ b/.github/workflows/links.yml
@@ -0,0 +1,44 @@
+# To run similar tasks locally, install lychee and run the following at the
root of the repository:
+# lychee .
+
+name: Links
+
+on:
+ repository_dispatch:
+ workflow_dispatch:
+ pull_request:
+ schedule:
+ - cron: "00 18 * * *"
+
+jobs:
+ check-links:
+ runs-on: ubuntu-latest
+ permissions:
+ issues: write # required for Broken Links Report
+ steps:
+ - uses: actions/checkout@v6
+
+ - name: Link Checker
+ id: lychee
+ uses: lycheeverse/lychee-action@v2
+ with:
+ args: --config lychee.toml .
+ fail: false
+
+ - name: Broken Links Report
+ if: steps.lychee.outputs.exit_code != 0 && github.event_name ==
'schedule'
+ uses: actions/github-script@v8
+ with:
+ script: |
+ const fs = require('fs');
+
+ // Read the markdown file
+ // Ensure the path is correct relative to the workspace root
+ const reportBody = fs.readFileSync('./lychee/out.md', 'utf8');
+
+ await github.rest.issues.create({
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ title: 'Broken Links Report',
+ body: reportBody
+ });
diff --git a/docs/qdp/getting-started.md b/docs/qdp/getting-started.md
index 3f9372d67..83ae588c7 100644
--- a/docs/qdp/getting-started.md
+++ b/docs/qdp/getting-started.md
@@ -72,9 +72,9 @@ engine.encode("data.parquet", num_qubits=10,
encoding_method="amplitude") # als
## Next Steps
-- [Concepts](../concepts/) - Learn about quantum encoding concepts
-- [API Reference](../api/) - Detailed API documentation
-- [Examples](../examples/) - More usage examples
+- [Concepts](./concepts/) - Learn about quantum encoding concepts
+- [API Reference](./api/) - Detailed API documentation
+- [Examples](./examples/) - More usage examples
## Help
diff --git a/lychee.toml b/lychee.toml
new file mode 100644
index 000000000..62f5ec93a
--- /dev/null
+++ b/lychee.toml
@@ -0,0 +1,10 @@
+exclude_path = [
+ "./docs/adr", # ADRs are not part of the core documentation
+ "./docs/blog", # Let's not check blog links for now
+ "./website/versioned*", # Focus on next version
+ "./website/static/download/downloads.html", # Should we fix in the future?
+ "./dev/rc-email-template.md", # Should we fix in the future?
+ "./docs/about/how-to-contribute.md", # TODO: fix the links in this file
+ "./qdp/docs/readers/README.md", # TODO: fix the links in this file
+]
+fallback_extensions = ["md"]
