Serverless Registry

Serverless Registry GitHub Actions

Composite GitHub Actions for publishing to and installing from Serverless Registry.

Composite GitHub Actions for Serverless Registry, built on the sreg CLI. Every action installs sreg from its GitHub releases (checksum verified) on Linux, macOS and Windows runners.

GitHub RepositoryMarketplace README
ActionWhat it does
kduma-OSS/serverless-registry-action/publish@v1Publishes one package version.
kduma-OSS/serverless-registry-action/setup@v1Only installs sreg and adds it to PATH.
kduma-OSS/serverless-registry-action/auth@v1Writes registry credentials for a package manager so installs work.
kduma-OSS/serverless-registry-action/get@v1Downloads files of a generic package version.

Publish

- uses: kduma-OSS/serverless-registry-action/publish@v1
  with:
    ecosystem: composer
    registry: https://packages.example.com
    token: ${{ secrets.REGISTRY_PUBLISH_TOKEN }}

Packaging tools (npm, cargo, dotnet, swift, Maven/Gradle) are not installed by the action - set them up in earlier steps. Main inputs:

InputDescription
ecosystemRequired: composer, npm, cargo, nuget, generic, swift or maven.
registryRequired: registry URL, exactly its PUBLIC_URL.
tokenToken whose scope includes publish. Empty: OIDC.
version / tag-prefixExplicit version, or take it from the tag with this prefix (monorepos).
path, workspace, package, project, from-dir, coords, scopeEcosystem specific selectors.
generic-files, generic-labelsFiles and labels for generic packages.
archivecomposer, npm, cargo, nuget: publish this archive (.zip, .tgz, .crate, .nupkg), built earlier, byte for byte (see below).
source-registry-indexcargo, with archive: index URL of the retired registry the crate was built for.
extra-flags, argsExtra sreg flags / packaging tool arguments after --.
dry-run, skip-existingskip-existing defaults to true, so re-running a workflow is safe.
sreg-versionPin a sreg release.

Outputs: name, version, url, skipped.

Authentication

Without secrets, using GitHub Actions OIDC. The registry needs a credential with the publish role and a gh secret scoped to publish that trusts the repository. One credential may also hold the read role with a separate gh secret scoped to read: the registry picks the entry by the role the command needs, so the same repository can install and publish without oidc-project:

permissions:
  contents: read
  id-token: write
steps:
  - uses: actions/checkout@v4
  - uses: kduma-OSS/serverless-registry-action/publish@v1
    with:
      ecosystem: composer
      registry: https://packages.example.com

Alternatively pass a token whose scope includes publish, or put credentials into the registry URL (store it as a secret). oidc-project is only needed when several credentials hold the needed role for the repository.

Monorepos

on:
  push:
    tags: ["sdk/v*"]
jobs:
  publish:
    runs-on: ubuntu-latest
    permissions: { contents: read, id-token: write }
    steps:
      - uses: actions/checkout@v4
      - uses: kduma-OSS/serverless-registry-action/publish@v1
        with:
          ecosystem: composer
          registry: https://packages.example.com
          path: packages/sdk
          tag-prefix: sdk/v

Publishing a prebuilt archive

Build, test and protect the archive in one job, download that artifact in the publishing job and pass it as archive: exactly those bytes are uploaded, the package, version and dependencies are read from the manifest inside the archive, and neither a checkout nor npm, cargo, dotnet or git is needed.

publish:
  runs-on: ubuntu-latest
  permissions:
    id-token: write
  steps:
    - uses: actions/download-artifact@v4
      with:
        name: dist
        path: dist
    - uses: kduma-OSS/serverless-registry-action/publish@v1
      with:
        ecosystem: npm
        registry: https://packages.example.com
        archive: dist/package.tgz

version is then only a consistency check; tag-prefix, path, workspace, package, project and args cannot be combined with archive. To migrate a crate built for a retired registry add source-registry-index: sparse+https://old.example.com/cargo/index/. archive needs an sreg release that has --archive (0.1.3 or newer) - set sreg-version accordingly if the action's default is older.

Auth

Lets package managers install from the registry, right before the install step:

- uses: kduma-OSS/serverless-registry-action/auth@v1
  with:
    ecosystem: composer
    registry: https://packages.example.com
- run: composer install

Supports composer, npm, cargo, nuget, swift and maven; takes a token whose scope includes read, or OIDC. Optional inputs: write (credentials file), registry-name, npm-scope, cargo-config, swift-scope. Output: file.

Get

- id: tool
  uses: kduma-OSS/serverless-registry-action/get@v1
  with:
    registry: https://packages.example.com
    token: ${{ secrets.REGISTRY_TOKEN }}
    name: tools/acme-tool
    version: ^1.2
    labels: os=linux
    sole: true
    out: bin/acme-tool.tar.gz

Outputs: version, files, path.

Versioning and pinning

@v1 follows the latest 1.x release; @v1.2.3 or a commit SHA pins it. Each release installs a default sreg release, and a new stable sreg is picked up by a patch release within an hour. Use sreg-version to pin sreg yourself (a pinned version must be raised manually when the registry requires a newer client - exit code 3).

The repository was formerly serverless-registry-publish-action; the old name and the root action still work in v1 but are deprecated. Use the publish/ subdirectory.

Documentation

Copyright © 2026