mirror of
https://github.com/storytold/effectcraft.git
synced 2026-11-16 15:22:43 +00:00
Plug-in Library: a package with an unreadable repo URL downloads nothing
When a package names a `repo` that isn't a GitHub repository URL (`https://github.com/<owner>/<repo>`, a trailing `/` or `.git` allowed, or a folder in one, `.../tree/<ref>/<path>`), Install, Update and Preview now refuse its release URLs with an error naming the package. Before, such a `repo` skipped the repository check and any GitHub release asset was downloaded. A package without a `repo` keeps any repository's release asset. The example catalog's schema now holds `repo` and release `url` to the same forms, and `scripts/validate.sh` checks that every release is an asset of the package's `repo` before it downloads anything.
This commit is contained in:
1 parent
75fed052e3
commit
5dfcadd09b
6 files changed
+117
-29
No files matched your search
+4
-2
@@ -375,8 +375,10 @@ package can't read files, open the network or crash the app.
|
||||
catalog gives one) against the catalog and loads it. Downloads use the system's `curl`,
|
||||
`https://` only and starting on GitHub's hosts (redirects stay on `https://`; the SHA-256 check
|
||||
is what guarantees the file). A package's `url` must be a release asset
|
||||
(`https://github.com/<owner>/<repo>/releases/download/…`), in the package's `repo` when that is
|
||||
a GitHub repository URL. A catalog other than the community one is read only when
|
||||
(`https://github.com/<owner>/<repo>/releases/download/…`). When the package names a `repo`, the
|
||||
asset must be in that repository. A `repo` that isn't `https://github.com/<owner>/<repo>` (with
|
||||
an optional trailing `/` or `.git`) or a folder in one (`https://github.com/<owner>/<repo>/tree/<ref>/…`)
|
||||
makes Install and Preview refuse every release of the package. A catalog other than the community one is read only when
|
||||
`library.refresh {catalog}` names it: an `index.json` on GitHub's hosts over `https://`, or a
|
||||
local `file://` path.
|
||||
* **Where it goes.** `<Plug-ins>/Library/<id>/<version>/<id>.wasm` (the `Plug-ins` folder next to
|
||||
|
||||
@@ -181,7 +181,7 @@ Package fields:
|
||||
| `author` | no | You, or your group. |
|
||||
| `description` | no, but reviewed | One or two plain sentences that say what the effect does. |
|
||||
| `license` | no, but reviewed | The licence's SPDX id (`MIT`, `Apache-2.0`, `MIT OR Apache-2.0`…). |
|
||||
| `repo` | no, but reviewed | The public source repository. The details' "Open on GitHub" opens it. |
|
||||
| `repo` | no, but reviewed | The public source repository, as `https://github.com/<owner>/<repo>` (a trailing `/` or `.git` is allowed), or a folder in it, `https://github.com/<owner>/<repo>/tree/<ref>/<path>`. The details' "Open on GitHub" opens it. When `repo` is given in any other form, Install and Preview refuse every release of the package. |
|
||||
| `tags` | no | Lower-case words for the tag filter (`blur`, `stylize`, `light`, `distort`…). Reuse tags the catalog already has. |
|
||||
| `preview.video` | no | An `https://` link to a short demo video on YouTube, Vimeo or GitHub. "Watch video" opens it in the browser. A link that isn't `https://` (or is longer than 500 characters) is left out. The live preview doesn't need it. |
|
||||
| `versions` | yes | One entry per release, newest or oldest first. |
|
||||
@@ -193,7 +193,7 @@ Release fields (one per entry in `versions`):
|
||||
| `version` | yes | Dotted numbers only, at most 32 characters: `1.0.0`, `1.2`. No `v` and no suffixes such as `-beta`. |
|
||||
| `api` | yes | The plug-in API the module implements: `1`. |
|
||||
| `minApp` | no | The oldest EffectCraft version the release needs (`0.17.0`). Leave it out if any version with this API works. |
|
||||
| `url` | yes | The release asset's `https://` URL on GitHub: `https://github.com/<owner>/<repo>/releases/download/<tag>/<file>`. When `repo` is a `https://github.com/<owner>/<repo>` URL, the asset must be in that repository. Install and Preview refuse any other `https://` URL. |
|
||||
| `url` | yes | The release asset's `https://` URL on GitHub: `https://github.com/<owner>/<repo>/releases/download/<tag>/<file>`. When the package has a `repo`, the asset must be in that repository. Install and Preview refuse any other `https://` URL. |
|
||||
| `sha256` | yes | The file's SHA-256, 64 hex digits. |
|
||||
| `size` | no, but reviewed | The file's size in bytes. When it is given, a download of another size is refused. |
|
||||
| `effects` | yes | The effect ids the module registers (its manifest's `id`). EffectCraft uses them to find the package that provides an effect a project needs. |
|
||||
|
||||
Reference in new issue
Block a user