Skip to content

Add each official plugin's license to its catalog releases #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nwparker merged 1 commit into from
Oct 30, 2026
Merged

Add each official plugin's license to its catalog releases #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,15 @@ ORCA_DIR=/path/to/orca node scripts/release-entry.mjs --write

For every directory in `plugins/`, this runs Orca's validator and writes the release it prints
(version, commit, `contentHash`, execution profile, minimum Orca, contributions, capabilities,
file types) into `orca-catalog.json`. A new version goes **first** in `releases`; an unchanged
version is updated in place. Don't edit these fields by hand: CI recomputes them and fails when
file types) and the manifest's `license` into `orca-catalog.json`. A new version goes **first** in
`releases`; an unchanged version is updated in place. Don't edit these fields by hand: CI recomputes them and fails when
they are stale. Commit `orca-catalog.json`.

When a release raises `engines.orca`, keep the previous release listed beneath it. Older Orca
installs the first release it supports, so removing the old one leaves those users with nothing
to install.

You may add display-only fields to a release: `changelog`, `updatedAt`, `license`, `homepage`,
You may add display-only fields to a release: `changelog`, `updatedAt`, `homepage`,
`themePreview`, `images`. The script keeps them.

## 3. Add a cover image (recommended)
Expand Down
21 changes: 21 additions & 0 deletions orca-catalog.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
"name": "Orca Midnight"
}
],
"license": "MIT",
"images": {
"cover": {
"path": "plugins/midnight-theme/images/cover.png",
Expand Down Expand Up @@ -86,6 +87,7 @@
"name": "Nord"
}
],
"license": "MIT",
"images": {
"cover": {
"path": "plugins/nord-theme/images/cover.png",
Expand Down Expand Up @@ -145,6 +147,7 @@
"name": "Orca OLED"
}
],
"license": "MIT",
"images": {
"cover": {
"path": "plugins/oled-theme/images/cover.png",
Expand Down Expand Up @@ -375,6 +378,7 @@
"editorFileTypes": [
"excalidraw"
],
"license": "MIT",
"images": {
"cover": {
"path": "plugins/excalidraw/images/cover.png",
Expand Down Expand Up @@ -445,6 +449,7 @@
"xls",
"ods"
],
"license": "MIT",
"images": {
"cover": {
"path": "plugins/spreadsheet/images/cover.png",
Expand Down Expand Up @@ -625,6 +630,7 @@
"name": "Ember"
}
],
"license": "MIT",
"images": {
"cover": {
"path": "plugins/dusk-ember/images/cover.png",
Expand Down Expand Up @@ -685,6 +691,7 @@
"name": "GitHub Light"
}
],
"license": "MIT",
"images": {
"cover": {
"path": "plugins/github-light-theme/images/cover.png",
Expand Down Expand Up @@ -712,6 +719,7 @@
"name": "GitHub Light"
}
],
"license": "MIT",
"images": {
"cover": {
"path": "plugins/github-light-theme/images/cover.png",
Expand Down Expand Up @@ -756,6 +764,7 @@
"name": "Solarized Light"
}
],
"license": "MIT",
"images": {
"cover": {
"path": "plugins/solarized-light-theme/images/cover.png",
Expand Down Expand Up @@ -800,6 +809,7 @@
"name": "Dracula"
}
],
"license": "MIT",
"images": {
"cover": {
"path": "plugins/dracula-theme/images/cover.png",
Expand Down Expand Up @@ -852,6 +862,7 @@
"name": "Gruvbox Light"
}
],
"license": "MIT",
"images": {
"cover": {
"path": "plugins/gruvbox-theme/images/cover.png",
Expand Down Expand Up @@ -895,6 +906,7 @@
"fileTypes": [
"nix"
],
"license": "MIT",
"images": {
"cover": {
"path": "assets/orca-nix/cover.jpg",
Expand Down Expand Up @@ -957,6 +969,7 @@
"gdshader",
"gdshaderinc"
],
"license": "MIT",
"images": {
"cover": {
"path": "assets/orca-godot/cover.jpg",
Expand Down Expand Up @@ -1006,6 +1019,7 @@
"ltx",
"sty"
],
"license": "MIT",
"images": {
"cover": {
"path": "assets/orca-latex/cover.jpg",
Expand Down Expand Up @@ -1052,6 +1066,7 @@
"editorFileTypes": [
"docx"
],
"license": "MIT",
"images": {
"cover": {
"path": "assets/orca-docx/cover.jpg",
Expand Down Expand Up @@ -1091,6 +1106,7 @@
"name": "Orca Run"
}
],
"license": "MIT",
"images": {
"cover": {
"path": "assets/orca-runner/orca-run-cover.png",
Expand All @@ -1114,6 +1130,7 @@
"name": "Orca Run"
}
],
"license": "MIT",
"images": {
"cover": {
"path": "assets/orca-runner/orca-run-cover.png",
Expand All @@ -1137,6 +1154,7 @@
"name": "Orca Run"
}
],
"license": "MIT",
"images": {
"cover": {
"path": "assets/orca-runner/orca-run-cover.png",
Expand All @@ -1160,6 +1178,7 @@
"name": "Orca Run"
}
],
"license": "MIT",
"images": {
"cover": {
"path": "assets/orca-runner/orca-run-cover.png",
Expand All @@ -1183,6 +1202,7 @@
"name": "Orca Runner"
}
],
"license": "MIT",
"images": {
"cover": {
"path": "assets/orca-runner/cover.png",
Expand All @@ -1206,6 +1226,7 @@
"name": "Orca Runner"
}
],
"license": "MIT",
"images": {
"cover": {
"path": "assets/orca-runner/cover.png",
Expand Down
5 changes: 5 additions & 0 deletions scripts/release-entry.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,11 @@ for (const sourcePath of dirs) {
// Why not HEAD: the catalog commit cannot name itself, and the plugin's bytes are the same at
// the last commit that touched its directory.
printed.commit = git('log', '-1', '--format=%H', 'HEAD', '--', sourcePath)
// Why copied: the validator prints no license, and the directory pages show the release's.
const { license } = JSON.parse(readFileSync(path.join(CATALOG_ROOT, sourcePath, 'orca-plugin.json'), 'utf8'))
if (typeof license === 'string' && license) {
printed.license = license
}
const releases = entry.releases ?? []
const newest = releases[0]
if (newest?.version === printed.version) {
Expand Down
Loading