From 660230aa817d5f83a17bb782a61645767cd5635b Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Thu, 19 Jun 2025 13:33:43 +0100 Subject: [PATCH] feat: Remove redundant link checker in GitHub configuration This commit removes the defunct check-broken-links workflow configuration, whose utility (Checking for broken links) was replaced by linkchecker some time ago. It also removes an outdated .txt file whose only content referenced the redundant action. In the future, detail about how the repository is configured will be available in the /documentation folder. --- .github/about.txt | 16 --------------- .github/workflows/check-broken-links.yml | 25 ------------------------ 2 files changed, 41 deletions(-) delete mode 100644 .github/about.txt delete mode 100644 .github/workflows/check-broken-links.yml diff --git a/.github/about.txt b/.github/about.txt deleted file mode 100644 index d556164ce..000000000 --- a/.github/about.txt +++ /dev/null @@ -1,16 +0,0 @@ -# GitHub Configurations - -This directory contains settings used by GitHub for Actions, identifying code reviewers, issue and pull request templates, and more. - -## Workflows - -### check-broken-links - -The check-broken-links workflow relies on the following projects: - -- https://github.com/BoundfoxStudios/action-hugo-link-check -- https://github.com/fenneclab/hugo-bin/releases - -The hugo-bin project lets you add Hugo as a dependency in your npm package.json file. The action-hugo-link-check Action requires this, as that is how it identifies which version of Hugo to run to build your docs. - -> Note: The release version numbers in the hugo-bin project do not align with the actual Hugo releases. Check the README and versions in the hugo-bin repo to find out which releases correspond to Hugo releases. diff --git a/.github/workflows/check-broken-links.yml b/.github/workflows/check-broken-links.yml deleted file mode 100644 index 3a9bbdfbb..000000000 --- a/.github/workflows/check-broken-links.yml +++ /dev/null @@ -1,25 +0,0 @@ -name: Check for Broken Links -# Generates the Hugo production site and checks for broken links -on: - workflow_dispatch: - # Run on pull requests with changed md files - # pull_request: - # paths: - # - 'content/**.md' - -jobs: - check-broken-links: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - uses: BoundfoxStudios/action-hugo-link-check@v2.0.3 - with: - hugo-root: ./ - hugo-content-dir: ./content - hugo-config: ./config/production/config.yaml - skip: github\.com\/nginxinc\/docs\/(tree|edit|new|issues\/new),twitter\.com\/nginx,linkedin\.com,facebook\.com,.*\/nginx-ingress-controller\/,.*\/nginxaas\/azure\/,.*\/nginx-amplify\/,.*\/nginx-agent\/,www\.nginx\.com,nginx\.com,www\.mywebsite\.com,example\.com - hugo-startup-wait-time: 60 - -