Scoop

Generate Scoop manifests for Windows package management

Anodizer generates Scoop JSON manifests and pushes them to your bucket repository.

Classification

See Release resilience for the full classification table and the Submitter gate semantics.

The required: field

Default: false — a Scoop bucket push failure is logged but does not fail the release.

Set required: true to make the release exit non-zero if this publisher fails:

crates:
  - name: myapp
    publish:
      scoop:
        repository:
          owner: myorg
          name: scoop-bucket
        required: true

See Publish overview — the required: field for the full semantics.

Minimal config

crates:
  - name: myapp
    publish:
      scoop:
        repository:
          owner: myorg
          name: scoop-bucket

Scoop config fields

Full config reference

crates:
  - name: myapp
    publish:
      scoop:
        repository:
          owner: myorg              # required
          name: scoop-bucket        # required
          token: ""                 # falls back to GITHUB_TOKEN
          branch: ""                # default: repo default branch
        description: "A fast CLI tool"   # optional; derived from Cargo.toml description
        license: MIT                     # optional; derived from Cargo.toml license
        checkver: github                 # optional; "github" (default) or a homepage regex
        skip_upload: false          # true | false | "auto" (skip prereleases)

Authentication

The token can also be set via repository.token in the config.

Common gotchas

• Only Windows archive artifacts are included in the manifest. Non-Windows targets are ignored.
• The checkver and autoupdate fields in the generated manifest reference the GitHub releases API, so the bucket can detect new versions automatically via scoop update.
• If the bucket repo requires a pull request (e.g., community buckets), use a fork + PR workflow — the direct-push model only works for self-hosted buckets.

Auto-update: checkver, autoupdate, per-arch extract_dir

ScoopInstaller/Main (and most community buckets) require a checkver + autoupdate pair so the bucket can detect and fetch new releases. Anodizer derives both automatically — you do not hand-write them:

• checkver defaults to github, pointing the bucket at the GitHub releases API for version detection. Override it with a homepage regex only when GitHub detection doesn't fit.
• autoupdate is emitted as a per-architecture block whose url is your archive name_template with the concrete version replaced by scoop's $version placeholder, plus a hash rule wired to the release's checksums. A checkver is only emitted alongside a usable autoupdate block — a checkver without autoupdate is a dead half-manifest, so anodizer never emits one alone.
• extract_dir is set per-architecture only when the archive wraps its contents in a top-level directory; both the live architecture block and the autoupdate block carry the matching extract_dir (with $version substituted in the autoupdate copy) so scoop install and scoop update find the binary at the same path.

"checkver": "github",
"autoupdate": {
  "architecture": {
    "64bit": {
      "url": "https://github.com/myorg/myapp/releases/download/v$version/myapp-$version-windows-amd64.zip"
    }
  }
}

Generated manifest

The manifest includes:

• Download URL for the Windows archive
• SHA-256 checksum
• Binary extraction path (and a per-arch extract_dir when the archive nests its contents)
• checkver and autoupdate templates for automatic updates