upm-release

A GitHub action to sign and release a Unity upm package.

How to use

When the action runs, it will:

1. Check out the repository.
2. Read the package.json file to get the package name and version.
3. Tag the repository with the package version, and optionally perform a subtree split to a specified branch (upm by default).
4. Sign the package using unity-cli.
5. Create a draft GitHub release with the signed package artifact on the subtree split branch (or default branch if subtree split is disabled).

Important

Make sure that the package.json file contains a valid semantic version (e.g., 1.0.0, 2.1.3, etc.) before running. If the version is not valid or an existing tag with the same version already exists, the action will fail.

The action will then generate a draft GitHub release with the tag name and upload the signed package as a release asset.

Requirements

• A Unity account with access to the organization that owns the package.
• Unity email and password stored as GitHub secrets.
• The organization cloud id stored as a GitHub secret.
• GITHUB_TOKEN secret to create releases and uploads. You may need to set the correct permissions or provide a personal access token if your repository is private or if the default token does not have sufficient permissions.

workflow

name: UPM Release
on:
  push:
    branch: [main]
  workflow_dispatch: # Optional: allows manual triggering of the workflow. Will attempt to make a draft release on the latest tag.
jobs:
  release:
    permissions:
      contents: write
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v5
      with:
        fetch-depth: 0
    - uses: RageAgainstThePixel/upm-release@v1
      with:
        username: ${{ secrets.UNITY_USERNAME }}
        password: ${{ secrets.UNITY_PASSWORD }}
        organization-id: ${{ secrets.UNITY_ORG_ID }}
        package-json: 'path/to/package.json' # optional, default is '**/Packages/**/package.json' glob search
        release-title: 'Optional release title for this release.' # optional, default is generated from package name and version
        release-notes: 'Optional release notes.' # optional, default is generated from commit message
        github-token: ${{ secrets.GITHUB_TOKEN }} # optional, default is GITHUB_TOKEN secret
        split-upm-branch: 'upm' # optional, default is to use the upm branch, but can be disabled by passing 'none'

inputs

name	description	required
username	The username for the Unity account.	true
password	The password for the Unity account.	true
organization-id	The organization ID for the Unity account.	true
package-json	Path to the package.json file. Defaults to **/Packages/**/package.json glob search.	false
release-title	The title for the GitHub release. If not provided, it will be generated from the package name and version.	false
release-notes	The release notes for the GitHub release. If not provided, it will be generated from the commit message.	false
github-token	GitHub token to create releases and upload assets. Defaults to the GITHUB_TOKEN secret, but may be required if permissions are not set correctly or the repository is private.	false
split-upm-branch	Optional branch name if the package release tag should be pushed to a different branch than the default branch. Pass 'none' to disable the subtree split.	false