Skip to content

feat: add versions.json version metadata contract#110

Merged
avivkeller merged 8 commits into
mainfrom
feat/add-versions-json
May 28, 2026
Merged

feat: add versions.json version metadata contract#110
avivkeller merged 8 commits into
mainfrom
feat/add-versions-json

Conversation

@ryzrr
Copy link
Copy Markdown
Member

@ryzrr ryzrr commented May 26, 2026

Links to : #105

Summary

Adds versions.json as the shared version metadata contract for the documentation pipeline. This is the single source of truth that update-versions.mjs, place-output.mjs, release.yml will all read from.

Real values: v5.x reflects the actual latest webpack release on npm (5.107.1) and the commit matches the current HEAD_COMMIT. The v6.x entry has null values since v6 has no npm release yet, these get filled automatically by release.yml when 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.mjs which 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.

Copilot AI review requested due to automatic review settings May 26, 2026 12:27
@vercel
Copy link
Copy Markdown

vercel Bot commented May 26, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
webpack-doc-kit Ready Ready Preview, Comment May 28, 2026 3:41pm

Request Review

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.json containing a latest pointer plus a versions[] list of version metadata.
  • Populates v5 with an exact npm version and a commit SHA matching HEAD_COMMIT; scaffolds v6 with null fields.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@ryzrr ryzrr self-assigned this May 26, 2026
Comment thread versions.json Outdated
Copy link
Copy Markdown
Member

@avivkeller avivkeller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

@ryzrr
Copy link
Copy Markdown
Member Author

ryzrr commented May 27, 2026

Sure, will add update-versions.mjs and release.yml and also the place-output.mjs to this PR. Give me a bit to get release.yml ready and I'll push everything together.

@ryzrr
Copy link
Copy Markdown
Member Author

ryzrr commented May 27, 2026

Dropped place-output.mjs - the frozen protection is already handled in release.yml via git diff on versions.json, so a separate guard script adds no real value here.

Comment thread scripts/update-versions.mjs
Comment thread versions.json Outdated
Copy link
Copy Markdown
Member

@avivkeller avivkeller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 thread .github/workflows/release.yml Outdated
Comment thread scripts/update-versions.mjs Outdated
Comment thread scripts/update-versions.mjs Outdated
Comment thread versions.json Outdated
@ryzrr
Copy link
Copy Markdown
Member Author

ryzrr commented May 28, 2026

will push the fixes with the two corrections once confirmed .

Co-authored-by: Aviv Keller <me@aviv.sh>
Copilot AI review requested due to automatic review settings May 28, 2026 12:25
Co-authored-by: Aviv Keller <me@aviv.sh>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.

Comment thread versions.json
Comment thread scripts/update-versions.mjs
Comment thread .github/workflows/release.yml Outdated
Comment thread .github/workflows/release.yml Outdated
Comment thread scripts/update-versions.mjs
Co-authored-by: Aviv Keller <me@aviv.sh>
Copilot AI review requested due to automatic review settings May 28, 2026 14:11
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 8 comments.

Comment thread versions.json
Comment thread scripts/update-versions.mjs
Comment thread scripts/update-versions.mjs
Comment thread scripts/update-versions.mjs
Comment thread scripts/update-versions.mjs
Comment thread .github/workflows/release.yml
Comment thread .github/workflows/release.yml Outdated
Comment thread versions.json
@ryzrr
Copy link
Copy Markdown
Member Author

ryzrr commented May 28, 2026

fixing the release.yml , I accidentally combined the typo and $COMMIT inside it

@avivkeller
Copy link
Copy Markdown
Member

Can you lint + add the generated file to .prettierignore?

@ryzrr
Copy link
Copy Markdown
Member Author

ryzrr commented May 28, 2026

Can you lint + add the generated file to .prettierignore?

okay

Copilot AI review requested due to automatic review settings May 28, 2026 15:33
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.

Comment thread versions.json
Comment thread scripts/update-versions.mjs Outdated
Comment thread .github/workflows/release.yml
Comment thread .github/workflows/release.yml
Comment thread .github/workflows/release.yml
@ryzrr
Copy link
Copy Markdown
Member Author

ryzrr commented May 28, 2026

Done !

@avivkeller avivkeller merged commit 09fdaaf into main May 28, 2026
4 checks passed
@avivkeller avivkeller deleted the feat/add-versions-json branch May 28, 2026 18:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants