Plugin Marketplace
Sign in

Documentation

Prusa Connect extensions/Publishing an extension

Publish from the author console

Sign and pack a release yourself, upload it, and follow it through the review.

All articles

You can sign and pack a release on your own machine and upload it in the author console. A release uploaded this way carries no source, so its code is not reviewed: only the archive, the binaries and the manifest are. Publish from GitHub Actions with the marketplace’s builder instead, which builds the extension from your source and sends that source with it.

The marketplace now accepts Connect releases from the builder alone: the author console no longer takes an upload, and this page stays only for reference. Publish from GitHub Actions.

You need an author profile and a signing key registered under Signing keys.

Sign and pack the release

Start from the release directory: module.yaml, one binary per platform and, when the manifest has a ui block, the browser bundle in ui/ (what a release contains). In the example extension, make release builds it into release/.

  1. Write checksums.txt. One line per file, in sha256sum format, over every file except the checksum file and the signature:

    cd release
    rm -f checksums.txt checksums.txt.sig
    find . -type f ! -name checksums.txt ! -name checksums.txt.sig | sed 's#^\./##' | sort \
      | xargs shasum -a 256 > checksums.txt

    On Linux, sha256sum writes the same lines as shasum -a 256.

  2. Sign it. The signature is your key’s RSA signature over checksums.txt, in base64:

    openssl dgst -sha256 -sign /path/to/private_key.pem checksums.txt | openssl base64 -A > checksums.txt.sig
    echo >> checksums.txt.sig
  3. Pack it. A .tar.gz of the directory’s contents, not of the directory itself, in plain ustar format:

    COPYFILE_DISABLE=1 tar --format=ustar -czf ../spools-1.2.0.tar.gz *

    COPYFILE_DISABLE=1 keeps macOS from adding its hidden ._ files, which the marketplace refuses. Elsewhere it does nothing.

Do not change a file after step 1. The marketplace stores the archive byte for byte, and Prusa Connect checks the same checksums and signature before it installs it.

Upload it

  1. Open Publish in the author console and choose Connect extension.
  2. Enter the Go module path, for example github.com/acme/spools. It gives the extension its id, so it stays the same for every release.
  3. Pick the .tar.gz, at most 128 MB.
  4. Choose the channel: stable, or beta for operators who opt in.
  5. Write what changed. The release notes show next to the version.
  6. Submit for review.

The marketplace checks right away that the signature verifies with one of your active keys, that the module path is yours to publish and that the version is new. If something is wrong, you get the reason at once and nothing is stored.

After the upload

The release is scanned, then waits for a person from Prusa, as described in what happens after you publish. The extension’s page in the author console shows where each release is, and the dashboard lists them all.

The console says What to do
add a signing key first Register the public key under Signing keys, then upload again.
checksums.txt.sig does not verify over checksums.txt against any of your signing keys Sign with a key whose public key is registered, and do not touch checksums.txt after signing.
the release is signed with a revoked key (or expired) Sign again with an active key.
... is published by another author The module path belongs to someone else’s extension. Use your own.
... holds U+…, a control or invisible character Write that field in module.yaml as plain text.
... was already uploaded; bump the version Raise version in module.yaml, then sign and pack again.
the archive is larger than 128 MB Leave out what the release does not need, such as debug symbols.