hashicorp/gh-action-check-broken-links
1
0
Fork 0
mirror of https://github.com/hashicorp/gh-action-check-broken-links synced 2026-04-05 18:55:07 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
15 commits 19 branches 5 tags 554 KiB
  • TypeScript 96.2%
  • MDX 2.2%
  • JavaScript 1.6%
Find a file
Exact
Jan Harrie 5d15d205f5
 Merge pull request #25 from hashicorp/tsccr-auto-pinning/trusted/2023-09-20 
SEC-090: Automated trusted workflow pinning (2023-09-20)
2023-09-20 15:46:04 +02:00
.github/workflows Result of tsccr-helper -log-level=info -pin-all-workflows . 2023-09-20 13:40:47 +00:00
@types Initial commit 2020-05-13 11:59:56 -04:00
__tests__ Account for introduction of content directory 2020-07-30 15:47:20 -04:00
dist Account for introduction of content directory 2020-07-30 15:47:20 -04:00
pages Minor tweaks 2020-05-14 00:14:55 -04:00
src Account for introduction of content directory 2020-07-30 15:47:20 -04:00
.eslintignore Initial commit 2020-05-13 11:59:56 -04:00
.eslintrc.js Initial commit 2020-05-13 11:59:56 -04:00
.gitignore Initial commit 2020-05-13 11:59:56 -04:00
.prettierignore Initial commit 2020-05-13 11:59:56 -04:00
action.yml Minor tweaks 2020-05-14 00:14:55 -04:00
jest.config.js Initial commit 2020-05-13 11:59:56 -04:00
LICENSE [COMPLIANCE] Add MPL 2.0 LICENSE 2022-10-12 18:42:25 +00:00
package-lock.json Account for introduction of content directory 2020-07-30 15:47:20 -04:00
package.json Account for introduction of content directory 2020-07-30 15:47:20 -04:00
prettier.config.js Initial commit 2020-05-13 11:59:56 -04:00
README.md Update README 2020-07-22 14:57:19 -04:00
tsconfig.json Initial commit 2020-05-13 11:59:56 -04:00

README.md

HashiCorp's Link Checker

C/I Status

A GitHub Action that reports all broken links found within a set of provided .mdx files

  • ⚠️ Currently only supports .mdx files
  • ⚠️ Assumes a Next.js project structure (i.e. links resolve from the /pages directory)

Features

Parses .mdx files, locating all links. Reports back any failed requests including those that contain a fragment identifier (i.e. https://example.com/page#identifier) but whose resulting markup does not.

Example Usage

- name: HashiCorp's Link Checker
  uses: hashicorp/gh-action-check-broken-links@v1
  with:
    baseUrl: 'https://hashicorp.com'
    files: 'pages/foo.mdx pages/bar.mdx'
    whitelist: |
      https://google.com/whitelist
      https://yahoo.com/whitelist