Skip to content

main: add hyperlink checker linkspector #5012

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 6, 2025
Merged

main: add hyperlink checker linkspector #5012

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eae7926
Add linkspector hyperlink checker
ralfhandl Oct 6, 2025
0a45a47
npm audit fix
ralfhandl Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 11 additions & 12 deletions .github/workflows/validate-markdown.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,20 @@ on: [push, pull_request]

jobs:
lint:

runs-on: ubuntu-latest

steps:

- uses: actions/checkout@v5 # checkout repo content
with:
fetch-depth: 0
- uses: actions/checkout@v5 # checkout repo content

- uses: actions/setup-node@v5 # setup Node.js
with:
node-version: "20.x"

- uses: actions/setup-node@v5 # setup Node.js
with:
node-version: '20.x'
- name: Lint work-in-progress spec
run: npx --yes markdownlint-cli2 --config spec.markdownlint.yaml src/oas.md

- name: Lint work-in-progress spec
run: npx --yes markdownlint-cli2 --config spec.markdownlint.yaml src/oas.md
- name: Lint other files
run: npx --yes markdownlint-cli2 *.md

- name: Lint other files
run: npx --yes markdownlint-cli2 *.md
- name: Check links in markdown files
run: npx --yes @umbrelladocs/linkspector check
15 changes: 15 additions & 0 deletions .linkspector.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
files:
- src/oas.md
- CONTRIBUTING.md
- EDITORS.md
# - GOVERNANCE.md
- IMPLEMENTATIONS.md
- MAINTAINERS.md
- README.md
- SECURITY_CONSIDERATIONS.md
- SPECIAL_INTEREST_GROUPS.md
- style-guide.md
- TOB.md
ignorePatterns:
- pattern: 'clientdomain.com'
- pattern: 'example.org'
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Looking to see how you can create your own OpenAPI definition, present it, or ot
The current process for developing the OpenAPI Specification is described in
the [Contributing Guidelines](CONTRIBUTING.md).

Developing the next version of the OpenAPI Specification is guided by the [Technical Steering Committee (TSC)](https://www.openapis.org/participate/how-to-contribute/governance#TDC). This group of committers bring their API expertise, incorporate feedback from the community, and expand the group of committers as appropriate. All development activity on the future specification will be performed as features and merged into this branch. Upon release of the future specification, this branch will be merged to `main`.
Developing the next version of the OpenAPI Specification is guided by the [Technical Steering Committee (TSC)](MAINTAINERS.md). This group of committers bring their API expertise, incorporate feedback from the community, and expand the group of committers as appropriate. All development activity on the future specification will be performed as features and merged into this branch. Upon release of the future specification, this branch will be merged to `main`.

The TSC holds weekly web conferences to review open pull requests and discuss open issues related to the evolving OpenAPI Specification. Participation in weekly calls and scheduled working sessions is open to the community. You can view the entire OpenAPI [technical meeting calendar](https://calendar.google.com/calendar/u/0/[email protected]) online.

Expand Down
Loading