From 1b3861f59f0efb5c73f387189c439370217adcdc Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 14 Jul 2026 07:42:29 +0000 Subject: [PATCH 1/2] Bump actions/setup-node from 6 to 7 Bumps [actions/setup-node](https://github.com/actions/setup-node) from 6 to 7. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](https://github.com/actions/setup-node/compare/v6...v7) --- updated-dependencies: - dependency-name: actions/setup-node dependency-version: '7' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/respec.yaml | 2 +- .github/workflows/schema-publish.yaml | 2 +- .github/workflows/schema-tests.yaml | 2 +- .github/workflows/validate-markdown.yaml | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/respec.yaml b/.github/workflows/respec.yaml index 3eaf2fbf47..5e74c4217f 100644 --- a/.github/workflows/respec.yaml +++ b/.github/workflows/respec.yaml @@ -31,7 +31,7 @@ jobs: with: fetch-depth: 0 - - uses: actions/setup-node@v6 # setup Node.js + - uses: actions/setup-node@v7 # setup Node.js with: node-version: "24.x" diff --git a/.github/workflows/schema-publish.yaml b/.github/workflows/schema-publish.yaml index 2a2193882d..ced764e095 100644 --- a/.github/workflows/schema-publish.yaml +++ b/.github/workflows/schema-publish.yaml @@ -34,7 +34,7 @@ jobs: with: fetch-depth: 0 - - uses: actions/setup-node@v6 # setup Node.js + - uses: actions/setup-node@v7 # setup Node.js with: node-version: "24.x" diff --git a/.github/workflows/schema-tests.yaml b/.github/workflows/schema-tests.yaml index 014c40d3b7..9cbfe488f6 100644 --- a/.github/workflows/schema-tests.yaml +++ b/.github/workflows/schema-tests.yaml @@ -23,7 +23,7 @@ jobs: with: fetch-depth: 0 - - uses: actions/setup-node@v6 # setup Node.js + - uses: actions/setup-node@v7 # setup Node.js with: node-version: '24.x' diff --git a/.github/workflows/validate-markdown.yaml b/.github/workflows/validate-markdown.yaml index aa802d4ffd..29117a08e0 100644 --- a/.github/workflows/validate-markdown.yaml +++ b/.github/workflows/validate-markdown.yaml @@ -17,7 +17,7 @@ jobs: steps: - uses: actions/checkout@v7 # checkout repo content - - uses: actions/setup-node@v6 # setup Node.js + - uses: actions/setup-node@v7 # setup Node.js with: node-version: "24.x" From 0ee400f40ed93ee1d0ca367e8acf0f531ed5f3f4 Mon Sep 17 00:00:00 2001 From: Miguel Quintero Date: Thu, 23 Jul 2026 16:55:34 -0400 Subject: [PATCH 2/2] Clarify local validation commands in CONTRIBUTING.md List the individual npm scripts (validate-markdown, format-markdown, build-src, test) so contributors can pick the fast lint/link-check loop while editing versus the full build/test pass before opening a PR. Co-Authored-By: Claude Sonnet 5 --- CONTRIBUTING.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b1f5ded15e..a6afd330bc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -179,16 +179,23 @@ Draft pull requests can still be reviewed while in draft state. > [!NOTE] > `npm run build-src` calls bash scripts. Use [Git Bash](https://gitforwindows.org/) on Windows, or use the Windows Subsystem for Linux (WSL). -The markdown source files are converted to HTML before publishing. -To do this locally, please +Before creating a pull request or marking a draft pull request as ready for review, validate your changes locally: 1. Install [Node.js](https://nodejs.org/) 2. Check out this repo, go to the repo root, and switch to a development branch 3. Execute `npm install` (once, repeat after merging upstream changes) -4. Execute `npm run build-src` after changing `src/oas.md` (this first executes `npm run validate-markdown`, which can also be run separately) -5. Open output file `deploy-preview/oas.html` with a browser and check your changes +4. Run the commands relevant to what you changed: -Please make sure the markdown validates and builds using the above steps before creating a pull request or marking a draft pull request as ready for review. + | Command | What it does | + | ------- | ------------- | + | `npm run validate-markdown` | markdownlint + link check only — fast loop while editing | + | `npm run format-markdown` | auto-fix markdownlint violations | + | `npm run build-src` | full check: validation, HTML build, schema publish | + | `npm test` | runs the JSON Schema and build tooling test suites | + +5. After `npm run build-src`, open output file `deploy-preview/oas.html` with a browser and check your changes + +Please make sure the markdown validates and builds, and that `npm test` passes, before creating a pull request or marking a draft pull request as ready for review. ## Reviewers