Skip to content

Commit eae7926

Browse files
committed
Add linkspector hyperlink checker
Add package dependency Add config file for linkspector Include in validate-markdown npm script Include in validate-markdown.yaml workflow Check other markdown files, fix link in README.md
1 parent 5f46ea3 commit eae7926

File tree

5 files changed

+1061
-31
lines changed

5 files changed

+1061
-31
lines changed

.github/workflows/validate-markdown.yaml

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,20 @@ on: [push, pull_request]
1313

1414
jobs:
1515
lint:
16-
1716
runs-on: ubuntu-latest
1817

1918
steps:
20-
21-
- uses: actions/checkout@v5 # checkout repo content
22-
with:
23-
fetch-depth: 0
19+
- uses: actions/checkout@v5 # checkout repo content
20+
21+
- uses: actions/setup-node@v5 # setup Node.js
22+
with:
23+
node-version: "20.x"
2424

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

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

32-
- name: Lint other files
33-
run: npx --yes markdownlint-cli2 *.md
31+
- name: Check links in markdown files
32+
run: npx --yes @umbrelladocs/linkspector check

.linkspector.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
files:
2+
- src/oas.md
3+
- CONTRIBUTING.md
4+
- EDITORS.md
5+
# - GOVERNANCE.md
6+
- IMPLEMENTATIONS.md
7+
- MAINTAINERS.md
8+
- README.md
9+
- SECURITY_CONSIDERATIONS.md
10+
- SPECIAL_INTEREST_GROUPS.md
11+
- style-guide.md
12+
- TOB.md
13+
ignorePatterns:
14+
- pattern: 'clientdomain.com'
15+
- pattern: 'example.org'

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Looking to see how you can create your own OpenAPI definition, present it, or ot
3333
The current process for developing the OpenAPI Specification is described in
3434
the [Contributing Guidelines](CONTRIBUTING.md).
3535

36-
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`.
36+
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`.
3737

3838
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.
3939

0 commit comments

Comments
 (0)