Skip to content

Commit faa20ca

Browse files
committed
Updated lychee configs
1 parent 936380e commit faa20ca

6 files changed

Lines changed: 47 additions & 20 deletions

File tree

.github/lychee.toml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# For all options, see <https://lychee.cli.rs/usage/config/>
2+
3+
# Verbose program output
4+
# Accepts log level: "error", "warn", "info", "debug", "trace"
5+
verbose = "info"
6+
7+
# Interactive progress bar while checking links.
8+
# Disabled for CI usage
9+
no_progress = true
10+
11+
# Enable link caching. This can be helpful to avoid checking the same links on
12+
# multiple runs.
13+
cache = true
14+
15+
accept = [
16+
"200"
17+
]
18+
19+
# Maximum number of allowed redirects.
20+
max_redirects = 2
21+
22+
# Maximum number of allowed retries before a link is declared dead.
23+
max_retries = 2
24+
25+
# Only test links with the given schemes
26+
# Omit to check links with any other scheme.
27+
scheme = ["http", "https", "file"]
28+
29+
# Exclude links
30+
exclude = [
31+
# Exclude links as cookies needed to be accepted
32+
'https://developer.arm.com',
33+
# Exclude flaky URL that intermittently times out in CI
34+
'https://www.gnu.org/software/make/'
35+
]
36+
37+
# Exclude paths from getting checked. The values are treated as regular expressions
38+
exclude_path = [
39+
"\\.txt$", # skip .txt extensions
40+
"\\.html$", # skip .html extensions
41+
"test/", # skip directories named "test"
42+
]

.github/markdown-link-check.jsonc

Lines changed: 0 additions & 15 deletions
This file was deleted.

.github/workflows/markdown.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ on:
55
- '.github/workflows/markdown.yml'
66
- '.github/markdownlint.json'
77
- '.github/markdownlint.jsonc'
8+
- '.github/lychee.toml'
89
- '**/*.md'
910

1011
permissions: read-all
@@ -14,5 +15,5 @@ jobs:
1415
uses: Open-CMSIS-Pack/workflows-and-actions-collection/.github/workflows/markdown-lint.yml@v2.0.0
1516
with:
1617
lint-config: '.github/markdownlint.jsonc'
17-
link-check-config: '.github/markdown-link-check.jsonc'
18+
link-check-config: '.github/lychee.toml'
1819
ignore-files: 'third_party_licenses.md,CHANGELOG.md'

DEVELOPING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Ensure you have the following installed:
88

99
- [GNU Make](https://www.gnu.org/software/make/)
1010
- [Golang](https://golang.org/doc/install)
11-
- [GolangCI-Lint](https://golangci-lint.run/usage/install/#local-installation)
11+
- [GolangCI-Lint](https://golangci-lint.run/docs/welcome/install/local/)
1212

1313
## Setup
1414

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
[![Release](https://github.com/Open-CMSIS-Pack/vidx2pidx/actions/workflows/release.yml/badge.svg)](https://github.com/Open-CMSIS-Pack/vidx2pidx/actions/workflows/release.yml)
2-
[![Build](https://github.com/open-cmsis-pack/vidx2pidx/actions/workflows/build.yml/badge.svg)](https://github.com/open-cmsis-pack/vidx2pidx/actions/workflows/build.yml/badge.svg)
3-
[![Tests](https://github.com/open-cmsis-pack/vidx2pidx/actions/workflows/test.yml/badge.svg)](https://github.com/open-cmsis-pack/vidx2pidx/actions/workflows/test.yml/badge.svg)
2+
[![Build And Test](https://github.com/Open-CMSIS-Pack/vidx2pidx/actions/workflows/ci.yml/badge.svg)](https://github.com/Open-CMSIS-Pack/vidx2pidx/actions/workflows/ci.yml)
43
[![Go Report Card](https://goreportcard.com/badge/github.com/open-cmsis-pack/vidx2pidx)](https://goreportcard.com/report/github.com/open-cmsis-pack/vidx2pidx)
54
[![GoDoc](https://godoc.org/github.com/open-cmsis-pack/vidx2pidx?status.svg)](https://godoc.org/github.com/open-cmsis-pack/vidx2pidx)
65

makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ release: test-all build/vidx2pidx
102102
config:
103103
@echo "Configuring local environment"
104104
@go version 2>/dev/null || echo "Need Golang: https://golang.org/doc/install"
105-
@golangci-lint version 2>/dev/null || echo "Need GolangCi-Lint: https://golangci-lint.run/usage/install/#local-installation"
105+
@golangci-lint version 2>/dev/null || echo "Need GolangCi-Lint: https://golangci-lint.run/docs/welcome/install/local/"
106106

107107
# Install pre-commit hooks
108108
cp scripts/pre-commit .git/hooks/pre-commit

0 commit comments

Comments
 (0)