From 23436fa8722745b4caa109e8bcc9d992f4af6c63 Mon Sep 17 00:00:00 2001 From: Andreas Taylor Date: Mon, 30 Sep 2024 16:00:05 -0500 Subject: [PATCH] Switch to lychee for link checks --- .github/workflows/CheckMarkdownLinks.yml | 24 ----------------- .github/workflows/check-links.yml | 33 ++++++++++++++++++++++++ .github/workflows/mlc_config.json | 3 --- README.md | 2 +- 4 files changed, 34 insertions(+), 28 deletions(-) delete mode 100644 .github/workflows/CheckMarkdownLinks.yml create mode 100644 .github/workflows/check-links.yml delete mode 100644 .github/workflows/mlc_config.json diff --git a/.github/workflows/CheckMarkdownLinks.yml b/.github/workflows/CheckMarkdownLinks.yml deleted file mode 100644 index f188721..0000000 --- a/.github/workflows/CheckMarkdownLinks.yml +++ /dev/null @@ -1,24 +0,0 @@ -# GitHub Action from: https://github.com/gaurav-nelson/github-action-markdown-link-check -# Uses code from: https://github.com/tcort/markdown-link-check -name: Check Markdown Links - -on: - push: - schedule: - # Run monthly - # GitHub actions uses UTC for time zone - # crontab format: minute hour day-of-month month day-of-week - - cron: "23 4 4 * *" - workflow_dispatch: - inputs: - message: - description: Message to display in job summary - required: false - type: string - -jobs: - markdown-link-check: - name: call-markdown-link-check-workflow - uses: Andy4495/.github/.github/workflows/CheckMarkdownLinks.yml@main - with: - message: ${{ inputs.message }} diff --git a/.github/workflows/check-links.yml b/.github/workflows/check-links.yml new file mode 100644 index 0000000..6a214b4 --- /dev/null +++ b/.github/workflows/check-links.yml @@ -0,0 +1,33 @@ +# https://github.com/lycheeverse/lychee-action +# https://github.com/lycheeverse/lychee +name: Check Links + +on: + push: + schedule: + # Run monthly + # GitHub actions uses UTC for time zone + # crontab format: minute hour day-of-month month day-of-week + - cron: "23 4 4 * *" + workflow_dispatch: + inputs: + message: + description: Message to display in job summary + required: false + type: string + override-args: + description: Override default arguments (see https://github.com/lycheeverse/lychee#commandline-parameters) + required: false + type: string + +jobs: + link-checker: + name: Call Link Checker + uses: Andy4495/.github/.github/workflows/check-links.yml@main + with: + message: ${{ inputs.message }} + override-args: ${{ inputs.override-args }} + # Use the following to exclude certain URLs from the check. Need to include "--exclude" in the definition. + # For example, --exclude '43oh.com' + exclude: + \ No newline at end of file diff --git a/.github/workflows/mlc_config.json b/.github/workflows/mlc_config.json deleted file mode 100644 index f18b248..0000000 --- a/.github/workflows/mlc_config.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "aliveStatusCodes": [429, 403, 200] -} diff --git a/README.md b/README.md index b86fdc9..18c930d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # LCD_SharpBoosterPack_SPI Library [![Arduino Compile Sketches](https://github.com/Andy4495/LCD_SharpBoosterPack_SPI/actions/workflows/arduino-compile-sketches.yml/badge.svg)](https://github.com/Andy4495/LCD_SharpBoosterPack_SPI/actions/workflows/arduino-compile-sketches.yml) -[![Check Markdown Links](https://github.com/Andy4495/LCD_SharpBoosterPack_SPI/actions/workflows/CheckMarkdownLinks.yml/badge.svg)](https://github.com/Andy4495/LCD_SharpBoosterPack_SPI/actions/workflows/CheckMarkdownLinks.yml) +[![Check Markdown Links](https://github.com/Andy4495/LCD_SharpBoosterPack_SPI/actions/workflows/check-links.yml/badge.svg)](https://github.com/Andy4495/LCD_SharpBoosterPack_SPI/actions/workflows/check-links.yml) This is a copy of the [LCD_SharpBoosterPack_SPI library][4] that is included with the [Energia application][1]. Version 2.0.0 contains changes as discussed below.