Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion .changeset/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,14 @@ This repo uses Changesets to drive releases for the published `executor` CLI.

Only `executor` is managed directly by Changesets.

Release PRs should only version the published CLI package instead of the rest of the workspace.
Release PRs should only mention the published CLI package directly. Changesets
will still version the fixed release group and dependent public packages as
needed, and will update each affected package's `CHANGELOG.md`.

Write the changeset body as the package changelog entry you want to appear in
the Version Packages PR and in the affected package changelogs. Keep broader
user-facing launch notes in `apps/cli/release-notes/next.md`; those are used for
the GitHub Release body.

## Beta releases

Expand Down
2 changes: 1 addition & 1 deletion .changeset/config.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://unpkg.com/@changesets/config@3.1.3/schema.json",
"changelog": false,
"changelog": "@changesets/cli/changelog",
"commit": false,
"fixed": [
[
Expand Down
6 changes: 1 addition & 5 deletions apps/cli/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1 @@
# executor changelog

This file exists so Changesets' release PR workflow can update package release metadata.

Canonical user-facing release notes are published on GitHub Releases.
# executor
7 changes: 1 addition & 6 deletions apps/desktop/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
# @executor-js/desktop changelog

This file exists for `changesets/action@v1` compatibility (it reads every
workspace package's `CHANGELOG.md` to build the Version Packages PR).
Canonical user-facing release notes are at `apps/cli/release-notes/next.md`
and on the GitHub Releases page.
# @executor-js/desktop
7 changes: 1 addition & 6 deletions apps/host-cloudflare/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
# @executor-js/host-cloudflare changelog

This file exists for `changesets/action@v1` compatibility (it reads every
workspace package's `CHANGELOG.md` to build the Version Packages PR).
Canonical user-facing release notes are at `apps/cli/release-notes/next.md`
and on the GitHub Releases page.
# @executor-js/host-cloudflare
7 changes: 1 addition & 6 deletions apps/host-selfhost/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
# @executor-js/host-selfhost changelog

This file exists for `changesets/action@v1` compatibility (it reads every
workspace package's `CHANGELOG.md` to build the Version Packages PR).
Canonical user-facing release notes are at `apps/cli/release-notes/next.md`
and on the GitHub Releases page.
# @executor-js/host-selfhost
5 changes: 1 addition & 4 deletions examples/all-plugins/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
# @executor-js/example-all-plugins changelog

This file exists for Changesets release workflow compatibility.
Canonical user-facing release notes are published on GitHub Releases.
# @executor-js/example-all-plugins
7 changes: 1 addition & 6 deletions examples/docs-sdk-quickstart/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
# @executor-js/example-docs-sdk-quickstart changelog

This file exists for `changesets/action@v1` compatibility (it reads every
workspace package's `CHANGELOG.md` to build the Version Packages PR).
Canonical user-facing release notes are at `apps/cli/release-notes/next.md`
and on the GitHub Releases page.
# @executor-js/example-docs-sdk-quickstart
7 changes: 1 addition & 6 deletions packages/app/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
# @executor-js/app changelog

This file exists for `changesets/action@v1` compatibility (it reads every
workspace package's `CHANGELOG.md` to build the Version Packages PR).
Canonical user-facing release notes are at `apps/cli/release-notes/next.md`
and on the GitHub Releases page.
# @executor-js/app
5 changes: 1 addition & 4 deletions packages/core/api/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
# @executor-js/api changelog

This file exists for Changesets release workflow compatibility.
Canonical user-facing release notes are published on GitHub Releases.
# @executor-js/api
5 changes: 1 addition & 4 deletions packages/core/cli/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
# @executor-js/cli changelog

This file exists for Changesets release workflow compatibility.
Canonical user-facing release notes are published on GitHub Releases.
# @executor-js/cli
5 changes: 1 addition & 4 deletions packages/core/config/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
# @executor-js/config changelog

This file exists for Changesets release workflow compatibility.
Canonical user-facing release notes are published on GitHub Releases.
# @executor-js/config
5 changes: 1 addition & 4 deletions packages/core/execution/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
# @executor-js/execution changelog

This file exists for Changesets release workflow compatibility.
Canonical user-facing release notes are published on GitHub Releases.
# @executor-js/execution
7 changes: 1 addition & 6 deletions packages/core/integrations-registry/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
# @executor-js/integrations-registry changelog

This file exists for `changesets/action@v1` compatibility (it reads every
workspace package's `CHANGELOG.md` to build the Version Packages PR).
Canonical user-facing release notes are at `apps/cli/release-notes/next.md`
and on the GitHub Releases page.
# @executor-js/integrations-registry
5 changes: 1 addition & 4 deletions packages/core/sdk/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
# @executor-js/core changelog

This file exists for Changesets release workflow compatibility.
Canonical user-facing release notes are published on GitHub Releases.
# @executor-js/sdk
5 changes: 1 addition & 4 deletions packages/core/test-servers/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
# @executor-js/test-servers changelog

This file exists for Changesets release workflow compatibility.
Canonical user-facing release notes are published on GitHub Releases.
# @executor-js/test-servers
7 changes: 1 addition & 6 deletions packages/core/vite-plugin/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
# @executor-js/vite-plugin changelog

This file exists for `changesets/action@v1` compatibility (it reads every
workspace package's `CHANGELOG.md` to build the Version Packages PR).
Canonical user-facing release notes are at `apps/cli/release-notes/next.md`
and on the GitHub Releases page.
# @executor-js/vite-plugin
7 changes: 1 addition & 6 deletions packages/hosts/cloudflare/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
# @executor-js/cloudflare changelog

This file exists for `changesets/action@v1` compatibility (it reads every
workspace package's `CHANGELOG.md` to build the Version Packages PR).
Canonical user-facing release notes are at `apps/cli/release-notes/next.md`
and on the GitHub Releases page.
# @executor-js/cloudflare
5 changes: 1 addition & 4 deletions packages/hosts/mcp/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
# @executor-js/host-mcp changelog

This file exists for Changesets release workflow compatibility.
Canonical user-facing release notes are published on GitHub Releases.
# @executor-js/host-mcp
5 changes: 1 addition & 4 deletions packages/kernel/core/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
# @executor-js/codemode-core changelog

This file exists for Changesets release workflow compatibility.
Canonical user-facing release notes are published on GitHub Releases.
# @executor-js/codemode-core
5 changes: 1 addition & 4 deletions packages/kernel/ir/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
# @executor-js/ir changelog

This file exists for Changesets release workflow compatibility.
Canonical user-facing release notes are published on GitHub Releases.
# @executor-js/ir
5 changes: 1 addition & 4 deletions packages/kernel/runtime-deno-subprocess/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
# @executor-js/runtime-deno-subprocess changelog

This file exists for Changesets release workflow compatibility.
Canonical user-facing release notes are published on GitHub Releases.
# @executor-js/runtime-deno-subprocess
5 changes: 1 addition & 4 deletions packages/kernel/runtime-quickjs/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
# @executor-js/runtime-quickjs changelog

This file exists for Changesets release workflow compatibility.
Canonical user-facing release notes are published on GitHub Releases.
# @executor-js/runtime-quickjs
7 changes: 1 addition & 6 deletions packages/plugins/desktop-settings/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
# @executor-js/plugin-desktop-settings changelog

This file exists for `changesets/action@v1` compatibility (it reads every
workspace package's `CHANGELOG.md` to build the Version Packages PR).
Canonical user-facing release notes are at `apps/cli/release-notes/next.md`
and on the GitHub Releases page.
# @executor-js/plugin-desktop-settings
7 changes: 1 addition & 6 deletions packages/plugins/encrypted-secrets/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
# @executor-js/plugin-encrypted-secrets changelog

This file exists for `changesets/action@v1` compatibility (it reads every
workspace package's `CHANGELOG.md` to build the Version Packages PR).
Canonical user-facing release notes are at `apps/cli/release-notes/next.md`
and on the GitHub Releases page.
# @executor-js/plugin-encrypted-secrets
7 changes: 1 addition & 6 deletions packages/plugins/example/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
# @executor-js/plugin-example changelog

This file exists for `changesets/action@v1` compatibility (it reads every
workspace package's `CHANGELOG.md` to build the Version Packages PR).
Canonical user-facing release notes are at `apps/cli/release-notes/next.md`
and on the GitHub Releases page.
# @executor-js/plugin-example
5 changes: 1 addition & 4 deletions packages/plugins/file-secrets/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
# @executor-js/plugin-file-secrets changelog

This file exists for Changesets release workflow compatibility.
Canonical user-facing release notes are published on GitHub Releases.
# @executor-js/plugin-file-secrets
7 changes: 1 addition & 6 deletions packages/plugins/graphql-greenfield/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
# @executor-js/plugin-graphql-greenfield changelog

This file exists for `changesets/action@v1` compatibility (it reads every
workspace package's `CHANGELOG.md` to build the Version Packages PR).
Canonical user-facing release notes are at `apps/cli/release-notes/next.md`
and on the GitHub Releases page.
# @executor-js/plugin-graphql-greenfield
5 changes: 1 addition & 4 deletions packages/plugins/graphql/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
# @executor-js/plugin-graphql changelog

This file exists for Changesets release workflow compatibility.
Canonical user-facing release notes are published on GitHub Releases.
# @executor-js/plugin-graphql
7 changes: 1 addition & 6 deletions packages/plugins/http-source/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
# @executor-js/plugin-http-source changelog

This file exists for `changesets/action@v1` compatibility (it reads every
workspace package's `CHANGELOG.md` to build the Version Packages PR).
Canonical user-facing release notes are at `apps/cli/release-notes/next.md`
and on the GitHub Releases page.
# @executor-js/plugin-http-source
5 changes: 1 addition & 4 deletions packages/plugins/keychain/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
# @executor-js/plugin-keychain changelog

This file exists for Changesets release workflow compatibility.
Canonical user-facing release notes are published on GitHub Releases.
# @executor-js/plugin-keychain
5 changes: 1 addition & 4 deletions packages/plugins/mcp/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
# @executor-js/plugin-mcp changelog

This file exists for Changesets release workflow compatibility.
Canonical user-facing release notes are published on GitHub Releases.
# @executor-js/plugin-mcp
5 changes: 1 addition & 4 deletions packages/plugins/onepassword/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
# @executor-js/plugin-onepassword changelog

This file exists for Changesets release workflow compatibility.
Canonical user-facing release notes are published on GitHub Releases.
# @executor-js/plugin-onepassword
5 changes: 1 addition & 4 deletions packages/plugins/openapi/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
# @executor-js/plugin-openapi changelog

This file exists for Changesets release workflow compatibility.
Canonical user-facing release notes are published on GitHub Releases.
# @executor-js/plugin-openapi
29 changes: 12 additions & 17 deletions scripts/check-changelog-stubs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@
* Verifies every workspace package directory has a `CHANGELOG.md` file.
*
* `changesets/action@v1` (the GitHub Action wrapping the Changesets CLI in
* `release.yml`) reads every workspace package's `CHANGELOG.md` to build
* the Version Packages PR description. If any is missing, the action
* crashes with `ENOENT` at release time and blocks the release.
* `release.yml`) creates the Version Packages PR after `changeset version`
* updates package versions and changelogs. Every workspace package should have
* a `CHANGELOG.md` seed so Changesets has a stable file to update and the
* action never falls back to missing-file behavior. Keep seed files H1-only:
* Changesets inserts generated version sections immediately after the H1, so
* any placeholder prose would become part of the first generated release notes.
*
* The CLI alone (with `changelog: false` in `.changeset/config.json`)
* doesn't need them — but we run via the Action, which does.
*
* The stubs themselves are not user-facing. Canonical release notes are
* at `apps/cli/release-notes/next.md` and on the GitHub Releases page.
* GitHub Release notes are still authored separately at
* `apps/cli/release-notes/next.md`; package changelogs are generated from
* `.changeset/*.md`.
*
* Usage:
* bun run scripts/check-changelog-stubs.ts # fail on missing
Expand Down Expand Up @@ -39,12 +40,7 @@ const findWorkspacePackages = (): string[] => {
return [...dirs].sort();
};

const STUB_TEMPLATE = (name: string) =>
`# ${name} changelog\n\n` +
"This file exists for `changesets/action@v1` compatibility (it reads every\n" +
"workspace package's `CHANGELOG.md` to build the Version Packages PR).\n" +
"Canonical user-facing release notes are at `apps/cli/release-notes/next.md`\n" +
"and on the GitHub Releases page.\n";
const STUB_TEMPLATE = (name: string) => `# ${name}\n`;

const fix = process.argv.includes("--fix");
const missing: string[] = [];
Expand All @@ -67,9 +63,8 @@ for (const pkgDir of findWorkspacePackages()) {
if (!fix && missing.length > 0) {
console.error(
`\nMissing CHANGELOG.md in ${missing.length} workspace package(s):\n - ${missing.join("\n - ")}\n\n` +
"These are required by `changesets/action@v1` (the GitHub Action wrapping\n" +
"Changesets in release.yml). Without them, release.yml crashes with ENOENT\n" +
"and the Version Packages PR can't open.\n\n" +
"These seed files are required so Changesets can update every affected\n" +
"workspace changelog during the Version Packages PR.\n\n" +
"Run `bun run scripts/check-changelog-stubs.ts --fix` to create stubs.\n",
);
process.exit(1);
Expand Down
Loading