Skip to content

Publish to OpenUPM as part of the release workflow - #6

Merged
jsantelys-as merged 1 commit into
mainfrom
feat/jsantelys/add-publish-workflow
Jul 17, 2026
Merged

Publish to OpenUPM as part of the release workflow#6
jsantelys-as merged 1 commit into
mainfrom
feat/jsantelys/add-publish-workflow

Conversation

@jsantelys-as

@jsantelys-as jsantelys-as commented Jul 17, 2026

Copy link
Copy Markdown
Collaborator

Summary

Wires OpenUPM publishing into the release pipeline so a version tag both cuts
the GitHub Release and publishes the package to OpenUPM, and documents the flow.

Changes

  • .github/workflows/release.yml: after creating the GitHub Release, the
    job now publishes to OpenUPM via openupm/openupm-action@v1, keyed off the
    pushed tag. Adds id-token: write so the action's OIDC flow works without an
    OpenUPM token or repository secret.
  • .openupm/package-metadata.yml: converted to a reference copy of the
    registered listing (the authoritative file lives in openupm/openupm), with
    updated description, topics, cover image, hunter, and Git tracking mode.
  • RELEASING.md: documents the OpenUPM scan/wait step, the OIDC-based
    action (no secret required), where to update authoritative listing metadata,
    and the stable-tag policy.

Notes

  • The package is already registered with OpenUPM in Git tracking mode; OpenUPM
    builds each version with npm pack on the matching Git tag rather than the
    ZIP attached to the GitHub Release.
  • The release workflow intentionally accepts bare stable tags (e.g. 1.0.1);
    supporting prereleases requires updating both package.json and the tag
    filter so the parsed tag version stays an exact match.

@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The release workflow now publishes com.appstack.unity-sdk to OpenUPM using the GitHub tag and OIDC. OpenUPM metadata and release-maintainer documentation were updated to describe tracking, validation, metadata ownership, and prerelease requirements.

Changes

OpenUPM release publishing

Layer / File(s) Summary
OpenUPM workflow and package metadata
.github/workflows/release.yml, .openupm/package-metadata.yml
The release job receives id-token: write permission and publishes the package through openupm/openupm-action@v1; OpenUPM metadata fields, topics, and reference instructions are updated.
Release procedure documentation
RELEASING.md
Release instructions document OpenUPM scanning, tag-based npm pack builds, OIDC publishing, authoritative metadata, and prerelease version matching.

Estimated code review effort: 2 (Simple) | ~10 minutes

Sequence Diagram(s)

sequenceDiagram
  participant GitHubActions
  participant GitHubRelease
  participant OpenUPM
  GitHubActions->>GitHubRelease: create and package tagged release
  GitHubActions->>OpenUPM: publish com.appstack.unity-sdk with github.ref_name
  OpenUPM-->>GitHubActions: report scan and installability status
Loading

Suggested reviewers: tomredlev-as

Poem

A rabbit tags the release with glee,
Then hops it toward OpenUPM’s tree.
OIDC unlocks the publishing door,
Metadata guides the package more.
“Build and install!” the bunny sings,
While docs explain the helpful things.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly describes the main change: adding OpenUPM publishing to the release workflow.
Description check ✅ Passed The description is directly related to the changes and accurately summarizes the workflow, metadata, and documentation updates.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/jsantelys/add-publish-workflow
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch feat/jsantelys/add-publish-workflow

Comment @coderabbitai help to get the list of available commands.

@jsantelys-as jsantelys-as changed the title Feat/jsantelys/add publish workflow Publish to OpenUPM on release; pin stable native SDKs; rename integration fixtures Jul 17, 2026
@coderabbitai coderabbitai Bot added the enhancement New feature or request label Jul 17, 2026
- Updated RELEASING.md to clarify the release workflow, including OpenUPM scan triggers and installation checks.
- Modified release.yml to include a step for publishing to OpenUPM, ensuring the package is built and published correctly.
- Revised .openupm/package-metadata.yml to reflect authoritative metadata and updated package details, including description and topics.
- Improved documentation to guide users on managing package metadata and OpenUPM registration.
@jsantelys-as
jsantelys-as force-pushed the feat/jsantelys/add-publish-workflow branch from 7186f52 to 1c755b3 Compare July 17, 2026 06:15
@jsantelys-as jsantelys-as changed the title Publish to OpenUPM on release; pin stable native SDKs; rename integration fixtures Publish to OpenUPM as part of the release workflow Jul 17, 2026
@coderabbitai coderabbitai Bot removed the enhancement New feature or request label Jul 17, 2026
@jsantelys-as
jsantelys-as merged commit 4e38b6c into main Jul 17, 2026
1 check passed
@jsantelys-as
jsantelys-as deleted the feat/jsantelys/add-publish-workflow branch July 17, 2026 06:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant