feat: add publish workflow by rtritto · Pull Request #3157 · vikejs/vike

rtritto · 2026-03-18T17:51:13Z

brillout · 2026-03-18T19:04:07Z

I understand your previous question now.

Can we make https://github.com/vikejs/vike/tags and the CHANGELOG.md be the source of truth here?

brillout · 2026-03-18T19:05:09Z

(FYI we use https://github.com/brillout/release-me throughout many projects — not using it would be a little too disruptive.)

rtritto · 2026-03-18T20:45:40Z

I understand your previous question now.

Can we make https://github.com/vikejs/vike/tags and the CHANGELOG.md be the source of truth here?

The goal is to create GitHub releases in https://github.com/vikejs/vike/releases

On the creation of a GitHub release, I think you want to get the changelog by the version in CHANGELOG.md and not by commits, right?

(FYI we use https://github.com/brillout/release-me throughout many projects — not using it would be a little too disruptive.)

Should this feature be done here?

brillout · 2026-03-18T20:49:22Z

I understand your previous question now.
Can we make https://github.com/vikejs/vike/tags and the CHANGELOG.md be the source of truth here?

The goal is to create GitHub releases in https://github.com/vikejs/vike/releases

Yes I know.

I think you want to get the changelog by the version in CHANGELOG.md and not by commits, right?

Yes, the source of truth should ideally be CHANGELOG.md and not the commits (to keep things DRY).

(FYI we use https://github.com/brillout/release-me throughout many projects — not using it would be a little too disruptive.)

Should this feature be done here?

Let's first do it here and then we can see whether we want to move it to @brillout/release-me.

rtritto · 2026-03-18T22:01:57Z

Yes, the source of truth should ideally be CHANGELOG.md and not the commits (to keep things DRY).

Done

brillout · 2026-03-18T22:11:12Z

How about we run this workflow when the CHANGELOG.md file changes?

One issue is that I have to regularly modify CHANGELOG.md manually — can we make the release tags be fully synced (all versions!) whenever CHANGELOG.md changes? That'd be a bullet proof approach 💯

rtritto · 2026-03-18T22:26:10Z

Sure, I can do.

Should I leave also the manual trigger (workflow_dispatch)?

brillout · 2026-03-18T22:43:15Z

One issue is that I have to regularly modify CHANGELOG.md manually — can we make the release tags be fully synced (all versions!) whenever CHANGELOG.md changes? That'd be a bullet proof approach 💯

To be clear: what I mean is that whenever CHANGELOG.md changes => all GitHub releases are re-generated from scratch. Does GitHub allow this?

Should I leave also the manual trigger (workflow_dispatch)?

Ok why not.

rtritto · 2026-03-19T00:02:36Z

To be clear: what I mean is that whenever CHANGELOG.md changes => all GitHub releases are re-generated from scratch. Does GitHub allow this?

Done (it needs to be tested)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

…add_publish_workflow

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

rtritto · 2026-03-20T15:43:25Z

Do you want a PR to fix CHANGELOG.md?

brillout · 2026-03-20T15:49:57Z

The best would be somewhat lenient:

I.e.:

If line doesn't contain x.y.z number => skip it
## and # treated the same

Also an ability to dry-run the script would be awesome. Let's us test the script without doing API requests.

rtritto · 2026-03-20T16:06:34Z

Done

brillout · 2026-03-20T16:13:46Z

~~Let's add a test for that last change~~
Let's add a test for a couple of first hundreds of LoC of Vike's changelog. Same for Telefunc, vike-vue, vike-solid, and vike-solid
Let's add dry-run

brillout · 2026-03-31T09:56:13Z

@rtritto Any luck? Polishing this PR makes a huge difference — if we can merge it once and then forget about it that'd be the best.

rtritto · 2026-03-31T13:57:55Z

This is LGTM, you can go ahead as you like

brillout · 2026-03-31T14:01:03Z

I'd rather merge after this:

feat: add publish workflow #3157 (comment)

Contribution welcome. We have a lot of higher priorities — we unfortunately cannot afford working on low-priority things.

…ish_workflow

This reverts commit 57141a8.

Copilot

Pull request overview

Adds automation to publish the vike package and keep GitHub Releases in sync with CHANGELOG.md, addressing the need from #3154 to create/update GitHub releases on new versions.

Changes:

Introduces a Bun/TypeScript script to derive release notes from CHANGELOG.md and create/update GitHub releases, with accompanying Vitest coverage and fixtures.
Adds a GitHub Actions workflow to run on CHANGELOG.md updates (and manual dispatch) to publish to npm and create/update the GitHub release.
Expands the pnpm workspace and Vitest configuration to treat workflow tooling as workspace packages and run their unit tests.

Reviewed changes

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

Show a summary per file

File	Description
vitest.config.ts	Expands unit test discovery to include `.github/*/.spec.ts` and adds exclusions.
pnpm-workspace.yaml	Broadens workspace package globs to include `.github/workflows/*` packages.
pnpm-lock.yaml	Updates lockfile importers for `.github/workflows/*` packages (devDependencies).
.github/workflows/sync-github-releases.yml	New workflow to publish to npm and create/update GitHub releases when `CHANGELOG.md` changes.
.github/workflows/sync-github-releases/sync-releases.ts	New script to parse changelog sections and sync GitHub releases via REST API.
.github/workflows/sync-github-releases/sync-releases.spec.ts	Unit tests covering changelog parsing and release planning, plus local fallback behavior.
.github/workflows/sync-github-releases/package.json	Adds local scripts for running/dry-running the release sync script with Bun.
.github/workflows/sync-github-releases/tsconfig.json	TypeScript config for the new workflow/package script.
.github/workflows/sync-github-releases/fixtures/changelog-vike.md	Fixture changelog content for parsing tests.
.github/workflows/sync-github-releases/fixtures/changelog-vike-vue.md	Fixture changelog content for parsing tests.
.github/workflows/sync-github-releases/fixtures/changelog-vike-solid.md	Fixture changelog content for parsing tests.
.github/workflows/sync-github-releases/fixtures/changelog-vike-react.md	Fixture changelog content for parsing tests.
.github/workflows/sync-github-releases/fixtures/changelog-telefunc.md	Fixture changelog content for parsing tests.
.github/workflows/ci/tsconfig.json	Adds Node types to support workflow TypeScript compilation/typechecking.
.github/workflows/ci/package.json	Moves workflow tooling deps to devDependencies and adds `@types/node`.

Files not reviewed (1)

pnpm-lock.yaml: Language not supported

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

Copilot · 2026-04-10T08:12:18Z

.github/workflows/sync-github-releases.yml

+      - name: Install modules
+        run: pnpm install --filter ./packages/vike
+      - name: Create NPM release
+        working-directory: ./packages/vike
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}


This workflow runs npm publish for packages/vike, but the repo doesn't contain a committed dist/ directory and there is no prepublish/prepare script in packages/vike/package.json to build it automatically. Add an explicit build step (e.g. run the package build script) before publishing to avoid publishing a broken package missing dist/* exports.

Copilot · 2026-04-10T08:12:19Z

.github/workflows/sync-github-releases/sync-releases.ts

@@ -0,0 +1,242 @@
+// Keeps GitHub releases aligned with `CHANGELOG.md`.
+// => It derives release notes from `CHANGELOG.md`, creates the current release if needed (and any missing releases), and updates existing releases whose published notes are outdated (e.g. if CHANGELOG.md was manually edited).


The top-of-file comment says this script creates "any missing releases" and updates outdated notes, but in the common case where at least one release already exists it only creates the current version and only considers releases returned by the single list call. Either adjust the comment to match the actual behavior, or extend the implementation to handle missing historical releases/updates as described.

Suggested change

// => It derives release notes from `CHANGELOG.md`, creates the current release if needed (and any missing releases), and updates existing releases whose published notes are outdated (e.g. if CHANGELOG.md was manually edited).

// => It derives release notes from `CHANGELOG.md`, creates the current release if needed, and updates inspected existing releases whose published notes are outdated (e.g. if `CHANGELOG.md` was manually edited).

Copilot · 2026-04-10T08:12:19Z

.github/workflows/sync-github-releases/sync-releases.ts

+  // https://docs.github.com/en/rest/releases/releases#list-releases
+  const releases = await githubRequest<Release[]>(`/repos/${owner}/${repo}/releases?per_page=100`, {
+    token,
+  })


The releases list request is hard-limited to the most recent 100 releases (per_page=100) and doesn't paginate. As a result, older releases beyond the first page can never be updated/considered, which conflicts with the goal of keeping releases aligned with the full CHANGELOG.md. Implement pagination (follow the Link header or increment page=) until all releases are fetched or until you reach the oldest relevant tag.

Copilot · 2026-04-10T08:12:20Z

.github/workflows/sync-github-releases/sync-releases.spec.ts

+  it('falls back to the production repository when run locally', () => {
+    const previous = process.env.GITHUB_REPOSITORY
+    try {
+      delete process.env.GITHUB_REPOSITORY
+      expect(getRepository()).toEqual({ owner: 'vikejs', repo: 'vike' })


This test hard-codes { owner: 'vikejs', repo: 'vike' } when GITHUB_REPOSITORY is unset. It will fail for contributors running tests on forks (where origin points to e.g. someone/vike) and for CI jobs that check out forks. Consider asserting only that getRepository() returns a valid {owner, repo} pair (or derive the expected value from git remote get-url origin within the test).

Suggested change

it('falls back to the production repository when run locally', () => {

const previous = process.env.GITHUB_REPOSITORY

try {

delete process.env.GITHUB_REPOSITORY

expect(getRepository()).toEqual({ owner: 'vikejs', repo: 'vike' })

it('returns a valid repository when run locally', () => {

const previous = process.env.GITHUB_REPOSITORY

try {

delete process.env.GITHUB_REPOSITORY

const repository = getRepository()

expect(repository.owner).toEqual(expect.any(String))

expect(repository.repo).toEqual(expect.any(String))

expect(repository.owner.trim()).not.toBe('')

expect(repository.repo.trim()).not.toBe('')

Copilot · 2026-04-10T08:12:20Z

.github/workflows/sync-github-releases/package.json

@@ -0,0 +1,10 @@
+{
+  "scripts": {
+    "run": "bun ./sync-releases.ts ",


The run script has a trailing space ("bun ./sync-releases.ts "), which is easy to miss and can cause confusing diffs or shell quoting issues later. Remove the trailing whitespace.

Suggested change

"run": "bun ./sync-releases.ts ",

"run": "bun ./sync-releases.ts",

brillout · 2026-04-10T08:24:02Z

@rtritto See copilot review above, up for working on it? Otherwise I'll close this.

feat: add publish workflow

411fad6

read changelog from CHANGELOG.md

7a6480d

rtritto added 5 commits March 19, 2026 00:57

add trigger workflow on CHANGELOG.md push

323941e

add missing fs import

4793d5e

add install pnpm

66fa136

add update release

bc02323

remove useless code

f973f0f

brillout and others added 14 commits March 19, 2026 08:20

add TODO/ai

c9f1bf9

[AI] Extract publish release script

74cf91d

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

[AI] Fix publish script TS compatibility

b38ee47

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

add TODO/ai

c3339a5

[AI] Implement publish workflow TODOs

066bca6

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

minor refactor

5a95da4

add TODO/ai

233ae0f

[AI] Rename GitHub release sync workflow

f370398

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

wip

da2575f

Merge remote-tracking branch 'origin/brillout/dev' into pr/3157-feat_…

bf27ee1

…add_publish_workflow

[AI] Skip CI fixture unit spec

8c98991

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

[AI] Exclude fixture dirs from Vitest

6485dc5

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

minor refactor

f2fd4d3

[AI] Fix workflow Node typings

ef831ec

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

allow single # and semantic x.y.z in regex

962e801

brillout added 14 commits April 10, 2026 08:21

opus

8f7f8cd

opus

f3ab531

opus

f466c29

opus

8883125

wip

aedfe6f

Merge remote-tracking branch 'origin/main' into pr/3157-feat_add_publ…

281e430

…ish_workflow

comment

c036577

minor refactor

b6381c7

opus

0c504c5

wip

4a1b300

wip

7a450f5

wip

7c7873d

wip

ae07225

wip

8215ff1

Copilot AI review requested due to automatic review settings April 10, 2026 08:06

try

57141a8

Copilot started reviewing on behalf of brillout April 10, 2026 08:06 View session

brillout added 2 commits April 10, 2026 10:07

Revert "try"

08c10a5

This reverts commit 57141a8.

wip

afe332c

Copilot AI reviewed Apr 10, 2026

View reviewed changes

wip

7614cef

		@@ -0,0 +1,242 @@
		// Keeps GitHub releases aligned with `CHANGELOG.md`.
		// => It derives release notes from `CHANGELOG.md`, creates the current release if needed (and any missing releases), and updates existing releases whose published notes are outdated (e.g. if CHANGELOG.md was manually edited).

	"run": "bun ./sync-releases.ts ",
	"run": "bun ./sync-releases.ts",

Uh oh!

Conversation

rtritto commented Mar 18, 2026

Uh oh!

brillout commented Mar 18, 2026

Uh oh!

brillout commented Mar 18, 2026

Uh oh!

rtritto commented Mar 18, 2026

Uh oh!

brillout commented Mar 18, 2026

Uh oh!

rtritto commented Mar 18, 2026

Uh oh!

brillout commented Mar 18, 2026

Uh oh!

rtritto commented Mar 18, 2026

Uh oh!

brillout commented Mar 18, 2026

Uh oh!

rtritto commented Mar 19, 2026

Uh oh!

rtritto commented Mar 20, 2026

Uh oh!

brillout commented Mar 20, 2026

Uh oh!

rtritto commented Mar 20, 2026

Uh oh!

brillout commented Mar 20, 2026

Uh oh!

brillout commented Mar 31, 2026

Uh oh!

rtritto commented Mar 31, 2026

Uh oh!

brillout commented Mar 31, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

brillout commented Apr 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants