diff --git a/.github/lychee.toml b/.github/lychee.toml new file mode 100644 index 0000000..1e48c4b --- /dev/null +++ b/.github/lychee.toml @@ -0,0 +1,42 @@ +# For all options, see + +# Verbose program output +# Accepts log level: "error", "warn", "info", "debug", "trace" +verbose = "info" + +# Interactive progress bar while checking links. +# Disabled for CI usage +no_progress = true + +# Enable link caching. This can be helpful to avoid checking the same links on +# multiple runs. +cache = true + +accept = [ + "200" +] + +# Maximum number of allowed redirects. +max_redirects = 2 + +# Maximum number of allowed retries before a link is declared dead. +max_retries = 2 + +# Only test links with the given schemes +# Omit to check links with any other scheme. +scheme = ["http", "https", "file"] + +# Exclude links +exclude = [ + # Exclude links as cookies needed to be accepted + 'https://developer.arm.com', + # Exclude flaky URL that intermittently times out in CI + 'https://www.gnu.org/software/make/' +] + +# Exclude paths from getting checked. The values are treated as regular expressions +exclude_path = [ + "\\.txt$", # skip .txt extensions + "\\.html$", # skip .html extensions + "test/", # skip directories named "test" +] diff --git a/.github/markdown-link-check.jsonc b/.github/markdown-link-check.jsonc deleted file mode 100644 index 8ee746d..0000000 --- a/.github/markdown-link-check.jsonc +++ /dev/null @@ -1,15 +0,0 @@ -{ - "ignorePatterns": [ - { - "pattern": "^https://opensource.org" - } - ], - "httpHeaders": [ - { - "urls": ["https://github.com/", "https://guides.github.com/", "https://help.github.com/", "https://docs.github.com/"], - "headers": { - "Accept-Encoding": "zstd, br, gzip, deflate" - } - } - ], -} diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a208c4d..97c6bd1 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -24,7 +24,7 @@ permissions: jobs: build-and-verify: - uses: Open-CMSIS-Pack/workflows-and-actions-collection/.github/workflows/build-and-verify.yml@v1.0.3 + uses: Open-CMSIS-Pack/workflows-and-actions-collection/.github/workflows/build-and-verify.yml@v2.0.0 secrets: QLTY_COVERAGE_TOKEN: ${{ secrets.QLTY_COVERAGE_TOKEN }} with: diff --git a/.github/workflows/markdown.yml b/.github/workflows/markdown.yml index cf1fbba..5ff655a 100644 --- a/.github/workflows/markdown.yml +++ b/.github/workflows/markdown.yml @@ -5,14 +5,15 @@ on: - '.github/workflows/markdown.yml' - '.github/markdownlint.json' - '.github/markdownlint.jsonc' + - '.github/lychee.toml' - '**/*.md' permissions: read-all jobs: markdown-check: - uses: Open-CMSIS-Pack/workflows-and-actions-collection/.github/workflows/markdown-lint.yml@v1.0.3 + uses: Open-CMSIS-Pack/workflows-and-actions-collection/.github/workflows/markdown-lint.yml@v2.0.0 with: lint-config: '.github/markdownlint.jsonc' - link-check-config: '.github/markdown-link-check.jsonc' + link-check-config: '.github/lychee.toml' ignore-files: 'third_party_licenses.md,CHANGELOG.md' diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 692d129..3b979c0 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -13,7 +13,7 @@ jobs: permissions: contents: read actions: write - uses: Open-CMSIS-Pack/workflows-and-actions-collection/.github/workflows/build-and-verify.yml@v1.0.3 + uses: Open-CMSIS-Pack/workflows-and-actions-collection/.github/workflows/build-and-verify.yml@v2.0.0 with: program: cpackget test-matrix: '[{"platform":"windows-2022","arch":"amd64"},{"platform":"ubuntu-24.04","arch":"amd64"}]' diff --git a/.github/workflows/update-workflows.yml b/.github/workflows/update-workflows.yml index d113624..b987f93 100644 --- a/.github/workflows/update-workflows.yml +++ b/.github/workflows/update-workflows.yml @@ -11,6 +11,6 @@ permissions: jobs: update-workflows: name: Update Workflow References - uses: Open-CMSIS-Pack/workflows-and-actions-collection/.github/workflows/update-workflow.yml@v1.0.3 + uses: Open-CMSIS-Pack/workflows-and-actions-collection/.github/workflows/update-workflow.yml@v2.0.0 secrets: TOKEN_ACCESS: ${{ secrets.GRASCI_WORKFLOW_UPDATE }} diff --git a/DEVELOPING.md b/DEVELOPING.md index 86cc196..a3d59b5 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -8,7 +8,7 @@ Ensure you have the following installed: - [GNU Make](https://www.gnu.org/software/make/) - [Golang](https://golang.org/doc/install) -- [GolangCI-Lint](https://golangci-lint.run/usage/install/#local-installation) +- [GolangCI-Lint](https://golangci-lint.run/docs/welcome/install/local/) ## Setup diff --git a/README.md b/README.md index 8166960..911a49b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ [![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) -[![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) -[![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) +[![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) [![Go Report Card](https://goreportcard.com/badge/github.com/open-cmsis-pack/vidx2pidx)](https://goreportcard.com/report/github.com/open-cmsis-pack/vidx2pidx) [![GoDoc](https://godoc.org/github.com/open-cmsis-pack/vidx2pidx?status.svg)](https://godoc.org/github.com/open-cmsis-pack/vidx2pidx) @@ -19,7 +18,7 @@ Just head to the release page and download the binary for your system. ## Usage -- update your `vendor.pidx` file as [documented](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/packIndexFile.html#pidxFile) +- update your `vendor.pidx` file as [documented](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/createPackPublish.html#packIndexFile) ```xml diff --git a/makefile b/makefile index 1475738..c312777 100644 --- a/makefile +++ b/makefile @@ -102,7 +102,7 @@ release: test-all build/vidx2pidx config: @echo "Configuring local environment" @go version 2>/dev/null || echo "Need Golang: https://golang.org/doc/install" - @golangci-lint version 2>/dev/null || echo "Need GolangCi-Lint: https://golangci-lint.run/usage/install/#local-installation" + @golangci-lint version 2>/dev/null || echo "Need GolangCi-Lint: https://golangci-lint.run/docs/welcome/install/local/" # Install pre-commit hooks cp scripts/pre-commit .git/hooks/pre-commit