feat: add versions.json version metadata contract#110
Open
ryzrr wants to merge 2 commits into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new root-level versions.json file intended to act as the shared “version metadata contract” for the documentation/release pipeline (per #105), capturing the current latest released webpack major (v5) and reserving an entry for v6 before an npm release exists.
Changes:
- Introduces
versions.jsoncontaining alatestpointer plus aversions[]list of version metadata. - Populates v5 with an exact npm version and a commit SHA matching
HEAD_COMMIT; scaffolds v6 withnullfields.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "frozen": false | ||
| }, | ||
| { | ||
| "label": "v6.x", |
Member
There was a problem hiding this comment.
is object for v6 required now?
update-version.mjs can add it when v6 is released
Member
Author
There was a problem hiding this comment.
It's a placeholder to validate the multi-version schema early rather than we discovering issues when v6 actually ships. I believe no cost to keeping it since the script update-version.mjs handles both cases.
avivkeller
requested changes
May 26, 2026
Member
avivkeller
left a comment
avivkeller
left a comment
There was a problem hiding this comment.
While the structure of the file looks good, I feel weird about adding an unused file, can you add the YAML and MJS files you mentioned to this PR?
Member
Author
|
Sure, will add |
Member
Author
|
Dropped |
Member
There was a problem hiding this comment.
are we expecting to manually set the prev version's frozen property to be true?
cause this script doesn't set it to true.
Member
Author
There was a problem hiding this comment.
Currently , Yes manually though it can be automated as well but this ensures we have explicit control of when a version gets frozen.
avivkeller
reviewed
May 27, 2026
| "major": 5, | ||
| "exactVersion": "5.107.1", | ||
| "commit": "0b60f1cba10640d886510999c1bfbca5f4ba7ab6", | ||
| "frozen": false |
Member
There was a problem hiding this comment.
I realize we don't actually need a frozen..., there simply won't be any new releases
avivkeller
reviewed
May 27, 2026
Member
avivkeller
left a comment
avivkeller
left a comment
There was a problem hiding this comment.
My review is purely a suggestion, and I'm not 100% sure that it's the way to go. Curious what you think about consolidating versions.json to just a string
Comment on lines
+1
to
+141
| name: Release | ||
|
|
||
| on: | ||
| release: | ||
| types: [published] | ||
|
|
||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
|
|
||
| jobs: | ||
| sync-docs: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | ||
|
|
||
| - name: Setup Node.js | ||
| uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0 | ||
| with: | ||
| node-version: lts/* | ||
| cache: 'npm' | ||
|
|
||
| # Packages go stale as doc-kit ships new features. Always reinstall from | ||
| # the lockfile before anything else. | ||
| - name: Install dependencies | ||
| run: npm ci | ||
|
|
||
| - name: Parse release tag and commit | ||
| id: release | ||
| run: | | ||
| TAG="${{ github.event.release.tag_name }}" | ||
| COMMIT="${{ github.event.release.target_commitish }}" | ||
| # npm install doesn't accept a leading v - strip it here | ||
| CLEAN_TAG="${TAG#v}" | ||
| MAJOR=$(echo "$CLEAN_TAG" | cut -d. -f1) | ||
| echo "tag=$TAG" >> "$GITHUB_OUTPUT" | ||
| echo "commit=$COMMIT" >> "$GITHUB_OUTPUT" | ||
| echo "clean_tag=$CLEAN_TAG" >> "$GITHUB_OUTPUT" | ||
| echo "clean_tag_major=$MAJOR" >> "$GITHUB_OUTPUT" | ||
| echo "Triggered by: $TAG @ $COMMIT" | ||
|
|
||
| - name: Update versions.json | ||
| id: versions | ||
| run: | | ||
| node scripts/update-versions.mjs "${{ steps.release.outputs.tag }}" "${{ steps.release.outputs.commit }}" | ||
| # If versions.json is unchanged after the script runs, this major is | ||
| # frozen. No point regenerating docs - nothing will differ. | ||
| if git diff --quiet versions.json; then | ||
| echo "frozen=true" >> "$GITHUB_OUTPUT" | ||
| echo "Version is frozen, skipping doc generation." | ||
| else | ||
| echo "frozen=false" >> "$GITHUB_OUTPUT" | ||
| fi | ||
|
|
||
| # Installing the exact release version updates package.json and | ||
| # package-lock.json so the lockfile stays in sync with what was used. | ||
| - name: Install webpack at release version | ||
| if: steps.versions.outputs.frozen == 'false' | ||
| run: npm install webpack@${{ steps.release.outputs.clean_tag }} | ||
|
|
||
| - name: Pin HEAD_COMMIT to release commit | ||
| if: steps.versions.outputs.frozen == 'false' | ||
| run: echo "${{ steps.release.outputs.commit }}" > HEAD_COMMIT | ||
|
|
||
| # Clone must come after npm install. TypeDoc needs to resolve types against | ||
| # the freshly installed webpack version, not whatever was in the lockfile. | ||
| - name: Clone webpack at release commit | ||
| if: steps.versions.outputs.frozen == 'false' | ||
| run: npm run clone-webpack | ||
|
|
||
| - name: Generate documentation | ||
| if: steps.versions.outputs.frozen == 'false' | ||
| run: npm run generate-docs | ||
|
|
||
| - name: Verify generated output | ||
| if: steps.versions.outputs.frozen == 'false' | ||
| run: | | ||
| LABEL="v${{ steps.release.outputs.clean_tag_major }}.x" | ||
| DOCS_DIR="pages/${LABEL}" | ||
| if [ ! -d "$DOCS_DIR" ]; then | ||
| echo "error: $DOCS_DIR was not generated" | ||
| exit 1 | ||
| fi | ||
| if [ ! -f "$DOCS_DIR/type-map.json" ]; then | ||
| echo "error: type-map.json missing from $DOCS_DIR" | ||
| exit 1 | ||
| fi | ||
| if [ -z "$(ls -A "$DOCS_DIR")" ]; then | ||
| echo "error: $DOCS_DIR is empty" | ||
| exit 1 | ||
| fi | ||
| echo "$DOCS_DIR looks good" | ||
|
|
||
| - name: Write job summary | ||
| if: steps.versions.outputs.frozen == 'false' | ||
| run: | | ||
| FILES=$(git diff --name-only pages/ | wc -l) | ||
| CATEGORIES=$(git diff --name-only pages/ \ | ||
| | sed 's|pages/[^/]*/||' \ | ||
| | cut -d/ -f1 \ | ||
| | sort -u \ | ||
| | tr '\n' ',' \ | ||
| | sed 's/,$//') | ||
| { | ||
| echo "## Doc generation summary" | ||
| echo "- **Release:** ${{ steps.release.outputs.tag }}" | ||
| echo "- **Commit:** \`${{ steps.release.outputs.commit }}\`" | ||
| echo "- **Pages updated:** ${FILES}" | ||
| echo "- **Affected categories:** ${CATEGORIES:-none detected}" | ||
| } >> "$GITHUB_STEP_SUMMARY" | ||
|
|
||
| - name: Open pull request | ||
| if: steps.versions.outputs.frozen == 'false' | ||
| uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v8.1.1 | ||
| with: | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| add-paths: | | ||
| versions.json | ||
| HEAD_COMMIT | ||
| package.json | ||
| package-lock.json | ||
| pages/ | ||
| commit-message: "docs: sync API documentation to webpack@${{ steps.release.outputs.tag }}" | ||
| title: "docs: sync API documentation to webpack@${{ steps.release.outputs.tag }}" | ||
| body: | | ||
| Automated doc sync triggered by the `${{ steps.release.outputs.tag }}` release. | ||
|
|
||
| **webpack commit:** `${{ steps.release.outputs.commit }}` | ||
|
|
||
| **Files in this PR:** | ||
| - `versions.json` -- updated `exactVersion` and `commit` for this release | ||
| - `HEAD_COMMIT` -- pinned to release commit | ||
| - `package.json` / `package-lock.json` -- webpack bumped to `${{ steps.release.outputs.tag }}` | ||
| - `pages/` -- regenerated API documentation | ||
|
|
||
| Check the Actions summary tab for a file count and category breakdown. CI must pass before merging. | ||
| labels: documentation | ||
| branch: "docs/release-${{ steps.release.outputs.tag }}" | ||
| delete-branch: true |
Member
There was a problem hiding this comment.
Suggested change
| name: Release | |
| on: | |
| release: | |
| types: [published] | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| jobs: | |
| sync-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0 | |
| with: | |
| node-version: lts/* | |
| cache: 'npm' | |
| # Packages go stale as doc-kit ships new features. Always reinstall from | |
| # the lockfile before anything else. | |
| - name: Install dependencies | |
| run: npm ci | |
| - name: Parse release tag and commit | |
| id: release | |
| run: | | |
| TAG="${{ github.event.release.tag_name }}" | |
| COMMIT="${{ github.event.release.target_commitish }}" | |
| # npm install doesn't accept a leading v - strip it here | |
| CLEAN_TAG="${TAG#v}" | |
| MAJOR=$(echo "$CLEAN_TAG" | cut -d. -f1) | |
| echo "tag=$TAG" >> "$GITHUB_OUTPUT" | |
| echo "commit=$COMMIT" >> "$GITHUB_OUTPUT" | |
| echo "clean_tag=$CLEAN_TAG" >> "$GITHUB_OUTPUT" | |
| echo "clean_tag_major=$MAJOR" >> "$GITHUB_OUTPUT" | |
| echo "Triggered by: $TAG @ $COMMIT" | |
| - name: Update versions.json | |
| id: versions | |
| run: | | |
| node scripts/update-versions.mjs "${{ steps.release.outputs.tag }}" "${{ steps.release.outputs.commit }}" | |
| # If versions.json is unchanged after the script runs, this major is | |
| # frozen. No point regenerating docs - nothing will differ. | |
| if git diff --quiet versions.json; then | |
| echo "frozen=true" >> "$GITHUB_OUTPUT" | |
| echo "Version is frozen, skipping doc generation." | |
| else | |
| echo "frozen=false" >> "$GITHUB_OUTPUT" | |
| fi | |
| # Installing the exact release version updates package.json and | |
| # package-lock.json so the lockfile stays in sync with what was used. | |
| - name: Install webpack at release version | |
| if: steps.versions.outputs.frozen == 'false' | |
| run: npm install webpack@${{ steps.release.outputs.clean_tag }} | |
| - name: Pin HEAD_COMMIT to release commit | |
| if: steps.versions.outputs.frozen == 'false' | |
| run: echo "${{ steps.release.outputs.commit }}" > HEAD_COMMIT | |
| # Clone must come after npm install. TypeDoc needs to resolve types against | |
| # the freshly installed webpack version, not whatever was in the lockfile. | |
| - name: Clone webpack at release commit | |
| if: steps.versions.outputs.frozen == 'false' | |
| run: npm run clone-webpack | |
| - name: Generate documentation | |
| if: steps.versions.outputs.frozen == 'false' | |
| run: npm run generate-docs | |
| - name: Verify generated output | |
| if: steps.versions.outputs.frozen == 'false' | |
| run: | | |
| LABEL="v${{ steps.release.outputs.clean_tag_major }}.x" | |
| DOCS_DIR="pages/${LABEL}" | |
| if [ ! -d "$DOCS_DIR" ]; then | |
| echo "error: $DOCS_DIR was not generated" | |
| exit 1 | |
| fi | |
| if [ ! -f "$DOCS_DIR/type-map.json" ]; then | |
| echo "error: type-map.json missing from $DOCS_DIR" | |
| exit 1 | |
| fi | |
| if [ -z "$(ls -A "$DOCS_DIR")" ]; then | |
| echo "error: $DOCS_DIR is empty" | |
| exit 1 | |
| fi | |
| echo "$DOCS_DIR looks good" | |
| - name: Write job summary | |
| if: steps.versions.outputs.frozen == 'false' | |
| run: | | |
| FILES=$(git diff --name-only pages/ | wc -l) | |
| CATEGORIES=$(git diff --name-only pages/ \ | |
| | sed 's|pages/[^/]*/||' \ | |
| | cut -d/ -f1 \ | |
| | sort -u \ | |
| | tr '\n' ',' \ | |
| | sed 's/,$//') | |
| { | |
| echo "## Doc generation summary" | |
| echo "- **Release:** ${{ steps.release.outputs.tag }}" | |
| echo "- **Commit:** \`${{ steps.release.outputs.commit }}\`" | |
| echo "- **Pages updated:** ${FILES}" | |
| echo "- **Affected categories:** ${CATEGORIES:-none detected}" | |
| } >> "$GITHUB_STEP_SUMMARY" | |
| - name: Open pull request | |
| if: steps.versions.outputs.frozen == 'false' | |
| uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v8.1.1 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| add-paths: | | |
| versions.json | |
| HEAD_COMMIT | |
| package.json | |
| package-lock.json | |
| pages/ | |
| commit-message: "docs: sync API documentation to webpack@${{ steps.release.outputs.tag }}" | |
| title: "docs: sync API documentation to webpack@${{ steps.release.outputs.tag }}" | |
| body: | | |
| Automated doc sync triggered by the `${{ steps.release.outputs.tag }}` release. | |
| **webpack commit:** `${{ steps.release.outputs.commit }}` | |
| **Files in this PR:** | |
| - `versions.json` -- updated `exactVersion` and `commit` for this release | |
| - `HEAD_COMMIT` -- pinned to release commit | |
| - `package.json` / `package-lock.json` -- webpack bumped to `${{ steps.release.outputs.tag }}` | |
| - `pages/` -- regenerated API documentation | |
| Check the Actions summary tab for a file count and category breakdown. CI must pass before merging. | |
| labels: documentation | |
| branch: "docs/release-${{ steps.release.outputs.tag }}" | |
| delete-branch: true | |
| name: Release | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| tag: | |
| description: 'Release tag (e.g. v5.99.0)' | |
| required: true | |
| type: string | |
| commit: | |
| description: 'Target commit SHA or branch' | |
| required: true | |
| type: string | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| jobs: | |
| sync: | |
| runs-on: ubuntu-latest | |
| env: | |
| TAG: ${{ inputs.tag }} | |
| COMMIT: ${{ inputs.commit }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0 | |
| with: | |
| node-version: lts/* | |
| cache: 'npm' | |
| - name: Install dependencies | |
| run: npm ci | |
| - name: Update files | |
| shell: bash | |
| run: | | |
| set -euo pipefail | |
| node scripts/update-versions.mjs "$TAG" "$COMMIT" | |
| echo "$COMMIT" > HEAD_COMMIT | |
| - name: Open pull request | |
| uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v8.1.1 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| commit-message: "chore: sync to webpack@${{ env.TAG }}" | |
| title: "core: sync to webpack@${{ env.TAG }}" | |
| body: | | |
| Automated version sync triggered by the `${{ env.TAG }}` release of `${{ env.COMMIT }}`. | |
| branch: "update-versions" | |
| draft: true | |
Member
There was a problem hiding this comment.
The reasons here:
- We need to
workflow_dispatch, since we are running on webpack releases, not releases in this repo - We don't need to generate anything, since that'll happen on deployment (we'll need to update our generation to do the checkout of multiple versions, this can be done in a follow-up)
- We don't need to check frozen-ness, since frozen means nothing (in the sense that frozen will be implied by the lack of new releases)
- We need to
draft: true, it's a GitHub actions quirk (see https://github.com/community/maintainers/discussions/740, note this repository is only accessible to verified maintainers)
Member
Author
There was a problem hiding this comment.
Got it, totally missed that releases fire on webpack/webpack not this repo and will move generation to a follow-up PR also spotted a small typo in the title, is it "core: sync" or it should be "chore: sync", and $COMMIT being passed to update-versions.mjs but the new script only takes the tag , i have already mentioned it in the below comment .
Comment on lines
+8
to
+11
| function fail(msg) { | ||
| console.error(`error: ${msg}`); | ||
| process.exit(1); | ||
| } |
Member
There was a problem hiding this comment.
Let's replace all fail() with throw new Error()
Comment on lines
+1
to
+59
| // Called from release.yml when a new webpack tag is published. | ||
| // Usage: node scripts/update-versions.mjs v5.108.0 <commit-sha> | ||
| import { readFileSync, writeFileSync } from 'fs'; | ||
| import { major, valid } from 'semver'; | ||
|
|
||
| const VERSIONS_FILE = './versions.json'; | ||
|
|
||
| function fail(msg) { | ||
| console.error(`error: ${msg}`); | ||
| process.exit(1); | ||
| } | ||
|
|
||
| const [tag, commit] = process.argv.slice(2); | ||
|
|
||
| if (!tag) fail('missing release tag (e.g. v5.108.0)'); | ||
| if (!commit) fail('missing commit SHA'); | ||
| if (!valid(tag)) fail(`"${tag}" is not a valid semver tag`); | ||
|
|
||
| const data = JSON.parse(readFileSync(VERSIONS_FILE, 'utf8')); | ||
|
|
||
| const incomingMajor = major(tag); | ||
| const label = `v${incomingMajor}.x`; | ||
| const exactVersion = tag.replace(/^v/, ''); | ||
|
|
||
| const existing = data.versions.find(v => v.major === incomingMajor); | ||
|
|
||
| if (existing) { | ||
| // frozen means the docs for this major are locked - don't touch them | ||
| if (existing.frozen) { | ||
| console.log(`${label} is frozen. Skipping.`); | ||
| process.exit(0); | ||
| } | ||
|
|
||
| existing.exactVersion = exactVersion; | ||
| existing.commit = commit; | ||
| console.log(`updated ${label} → ${exactVersion} @ ${commit}`); | ||
| } else { | ||
| // first release of a new major - create the entry from scratch | ||
| data.versions.push({ | ||
| label, | ||
| major: incomingMajor, | ||
| exactVersion, | ||
| commit, | ||
| frozen: false, | ||
| }); | ||
| console.log(`created new entry for ${label} → ${exactVersion} @ ${commit}`); | ||
| } | ||
|
|
||
| // only move latest forward, never back | ||
| const currentLatestMajor = | ||
| data.versions.find(v => v.label === data.latest)?.major ?? 0; | ||
| if (incomingMajor > currentLatestMajor) { | ||
| data.latest = label; | ||
| console.log(`latest promoted to ${label}`); | ||
| } | ||
|
|
||
| writeFileSync(VERSIONS_FILE, JSON.stringify(data, null, 2) + '\n'); | ||
| console.log(`versions.json written`); | ||
| process.exit(0); |
Member
There was a problem hiding this comment.
Suggested change
| // Called from release.yml when a new webpack tag is published. | |
| // Usage: node scripts/update-versions.mjs v5.108.0 <commit-sha> | |
| import { readFileSync, writeFileSync } from 'fs'; | |
| import { major, valid } from 'semver'; | |
| const VERSIONS_FILE = './versions.json'; | |
| function fail(msg) { | |
| console.error(`error: ${msg}`); | |
| process.exit(1); | |
| } | |
| const [tag, commit] = process.argv.slice(2); | |
| if (!tag) fail('missing release tag (e.g. v5.108.0)'); | |
| if (!commit) fail('missing commit SHA'); | |
| if (!valid(tag)) fail(`"${tag}" is not a valid semver tag`); | |
| const data = JSON.parse(readFileSync(VERSIONS_FILE, 'utf8')); | |
| const incomingMajor = major(tag); | |
| const label = `v${incomingMajor}.x`; | |
| const exactVersion = tag.replace(/^v/, ''); | |
| const existing = data.versions.find(v => v.major === incomingMajor); | |
| if (existing) { | |
| // frozen means the docs for this major are locked - don't touch them | |
| if (existing.frozen) { | |
| console.log(`${label} is frozen. Skipping.`); | |
| process.exit(0); | |
| } | |
| existing.exactVersion = exactVersion; | |
| existing.commit = commit; | |
| console.log(`updated ${label} → ${exactVersion} @ ${commit}`); | |
| } else { | |
| // first release of a new major - create the entry from scratch | |
| data.versions.push({ | |
| label, | |
| major: incomingMajor, | |
| exactVersion, | |
| commit, | |
| frozen: false, | |
| }); | |
| console.log(`created new entry for ${label} → ${exactVersion} @ ${commit}`); | |
| } | |
| // only move latest forward, never back | |
| const currentLatestMajor = | |
| data.versions.find(v => v.label === data.latest)?.major ?? 0; | |
| if (incomingMajor > currentLatestMajor) { | |
| data.latest = label; | |
| console.log(`latest promoted to ${label}`); | |
| } | |
| writeFileSync(VERSIONS_FILE, JSON.stringify(data, null, 2) + '\n'); | |
| console.log(`versions.json written`); | |
| process.exit(0); | |
| import { readFileSync, writeFileSync } from 'node:fs'; | |
| import { major, valid } from 'semver'; | |
| const VERSIONS_FILE = './versions.json'; | |
| const [tag] = process.argv.slice(2); | |
| if (!tag) throw new Error('Missing release tag (e.g. v5.108.0)'); | |
| if (!valid(tag)) throw new Error(`"${tag}" is not a valid semver tag`); | |
| const latestMajor = major(tag); | |
| const data = JSON.parse(readFileSync(VERSIONS_FILE, 'utf8')); | |
| const existingIndex = data.findIndex((v) => major(v) === latestMajor); | |
| if (existingIndex !== -1) { | |
| data[existingIndex] = tag; | |
| console.log(`Updated v${latestMajor}.x to ${tag}`); | |
| } else { | |
| data.unshift(tag); | |
| console.log(`Created new entry for v${latestMajor}.x: ${tag}`); | |
| } | |
| writeFileSync(VERSIONS_FILE, JSON.stringify(data, null, 2)); | |
| console.log('versions.json written'); |
Member
There was a problem hiding this comment.
Explanation of changes:
- As mentioned previously, we really only need the tag
- Rather than using
.latest, we can use.[0], so versions are sorted (.unshift()) fail=>throw new Error
Member
Author
There was a problem hiding this comment.
Accepting points 2 and 3. One thing I noticed - the suggested release.yml passes $COMMIT as a second argument to update-versions.mjs but the new script only reads the tag. Should I remove $COMMIT from that call since HEAD_COMMIT is already updated separately on the next line?
Comment on lines
+1
to
+19
| { | ||
| "latest": "v5.x", | ||
| "versions": [ | ||
| { | ||
| "label": "v5.x", | ||
| "major": 5, | ||
| "exactVersion": "5.107.1", | ||
| "commit": "0b60f1cba10640d886510999c1bfbca5f4ba7ab6", | ||
| "frozen": false | ||
| }, | ||
| { | ||
| "label": "v6.x", | ||
| "major": 6, | ||
| "exactVersion": null, | ||
| "commit": null, | ||
| "frozen": false | ||
| } | ||
| ] | ||
| } No newline at end of file |
Member
There was a problem hiding this comment.
Suggested change
| { | |
| "latest": "v5.x", | |
| "versions": [ | |
| { | |
| "label": "v5.x", | |
| "major": 5, | |
| "exactVersion": "5.107.1", | |
| "commit": "0b60f1cba10640d886510999c1bfbca5f4ba7ab6", | |
| "frozen": false | |
| }, | |
| { | |
| "label": "v6.x", | |
| "major": 6, | |
| "exactVersion": null, | |
| "commit": null, | |
| "frozen": false | |
| } | |
| ] | |
| } | |
| ["v5.107.1"] |
Member
There was a problem hiding this comment.
What if we only include the versions like this? That's really all the info we need, right?
Member
Author
There was a problem hiding this comment.
Makes sense, simpler to work with and we can derive everything else from the semver string directly.
Member
Author
|
will push the fixes with the two corrections once confirmed . |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Links to : #105
Summary
Adds
versions.jsonas the shared version metadata contract for the documentation pipeline. This is the single source of truth thatupdate-versions.mjs,place-output.mjs,release.ymlwill all read from.Real values:
v5.xreflects the actual latest webpack release on npm (5.107.1) and the commit matches the currentHEAD_COMMIT. Thev6.xentry hasnullvalues since v6 has no npm release yet, these get filled automatically byrelease.ymlwhen webpack tags a v6 release.What kind of change does this PR introduce?
New file, no existing behaviour is modified.
Did you add tests for your changes?
Tests will come alongside
update-versions.mjswhich reads and mutates this file. Adding them here in isolation would not be meaningful without the script that uses it.Does this PR introduce a breaking change?
No. Nothing currently depends on this file.
If relevant, what needs to be documented?
Schema is already documented and shared with the team.
Use of AI
Used for writing the PR Desc.