Skip to content
Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Register Jolter Release Action

GitHub Action that registers a published plugin release with the Jolter registry using either a Jolter registry personal token or a repository-scoped GitHub token; plugin artifacts remain hosted in the GitHub Release.

The release must contain:

  • A WebAssembly asset
  • plugin.json
  • Optional checksums.txt

Use

Using GitHub OIDC (Recommended)

name: Register Jolter release

on:
  release:
    types: [published]

permissions:
  id-token: write
  contents: write

jobs:
  register:
    runs-on: ubuntu-latest
    steps:
      - uses: jolterjs/register-release-action@v1.3
        with:
          registry-url: https://registry.jolter.dev
          plugin-name: "@jolter/example"
          github-token: ${{ github.token }}

Using a GitHub Token

name: Register Jolter release

on:
  release:
    types: [published]

permissions:
  contents: write

jobs:
  register:
    runs-on: ubuntu-latest
    steps:
      - uses: jolterjs/register-release-action@v1.3
        with:
          registry-url: https://registry.jolter.dev
          plugin-name: "@jolter/example"
          github-token: ${{ github.token }}

Using a Jolter Registry Personal Access Token

name: Register Jolter release

on:
  release:
    types: [published]

jobs:
  register:
    runs-on: ubuntu-latest
    steps:
      - uses: jolterjs/register-release-action@v1.3
        with:
          registry-url: https://registry.jolter.dev
          plugin-name: "@jolter/example"
          token: ${{ secrets.JOLTER_REGISTRY_TOKEN }}

The action obtains the release tag from the release event and strips a leading v for the semantic version. version and release-tag inputs can override this behavior.

Rerunning the action is safe: an HTTP 409 response for an existing version is reported as registered=false rather than failing the workflow.

Inputs

Input Required Description
registry-url Yes Registry server origin
plugin-name Yes Canonical plugin name or alias
token No* Jolter registry personal access token
jolter-token No* Alias for token (Jolter registry personal access token)
github-token No* Repository-scoped GitHub token with contents write permission
id-token No* GitHub Actions OIDC ID token (automatically fetched if id-token: write permission is set)
id-token-audience No Custom audience for GitHub Actions OIDC ID token
version No Semantic version override
release-tag No GitHub release tag override

* At least one authentication method must be provided: token, github-token, or GitHub Actions OIDC permission (id-token: write).

Outputs

  • version
  • release-tag
  • registered

Development

bun install
bun run typecheck
bun test
bun run build
bun run format:check

GitHub executes dist/index.js, so rebuild and commit dist whenever source changes.

See CONTRIBUTING.md for contribution guidelines and local development notes.

About

Official register release action for the Jolter Plugin Registry

Topics

Resources

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Sponsor this project

Contributors

Languages