Skip to content

build(release): publish the package from a release workflow - #190

Draft
erkamyaman wants to merge 3 commits into
santoshyadavdev:mainfrom
erkamyaman:ci/release-workflow
Draft

erkamyaman wants to merge 3 commits into
santoshyadavdev:mainfrom
erkamyaman:ci/release-workflow

Conversation

@erkamyaman

Copy link
Copy Markdown
Collaborator

Adds a Release workflow (.github/workflows/release.yml) so the package is published from GitHub Actions instead of by hand.

What it does

Run by hand from the Actions tab, on main only, with a version (patch, minor or an exact x.y.z):

  1. Runs the CI checks on the commit (ci.yml as a reusable workflow).
  2. Sets the version in packages/ng-devtools/package.json.
  3. Takes the release notes from the ## <version> - <date> section of packages/ng-devtools/CHANGELOG.md, and stops if there isn't one.
  4. Packs the package and checks the tarball with pnpm verify:publish --tarball=....
  5. Publishes with --provenance through npm trusted publishing (OIDC, no token stored). It skips the publish if that version is already on npm, so a rerun finishes a half-done release.
  6. Commits the version, tags ng-devtools@<version> and creates the GitHub release.

publishing.md covers the one-time setup and each release, and keeps the manual commands as a fallback.

Setup needed before the first run

  • On npmjs.com, in the @santoshyadavdev/ng-devtools settings, add a trusted publisher: GitHub Actions, owner santoshyadavdev, repository angular-devtools, workflow release.yml, no environment.
  • If main is protected, let GitHub Actions push the version commit and tag.
  • Settings > Actions > Workflow permissions: "Read and write".

Checks

  • actionlint and pnpm format:check pass
  • Changelog section extraction and the version bump (patch, minor, exact) checked locally, including 0.0.6 vs 0.0.60
  • pnpm verify:publish --tarball=... passed locally

…wners

Adds skills for fixing one issue, working through a batch and settling
open decisions, a glossary of project terms, and a repository section
in AGENTS.md with its commands and the rules that fail quietly.
CLAUDE.md now imports AGENTS.md, and the generic Angular rules move to
.claude/rules. Adds a publish check against a local registry, a weekly
run of it on the newest versions our ranges allow, issue triage from
the issue forms, an area prefix for issue titles, a shared setup
action for the workflows, and both maintainers as code owners.

Refs santoshyadavdev#100
Adds a Release workflow run by hand on main. It runs the CI checks,
sets the version, takes the notes from the changelog, checks the
packed tarball through a local registry, publishes with provenance
through npm trusted publishing, then commits the version, tags it and
creates the GitHub release. The publishing guide covers the one-time
npm setup and keeps the manual commands as a fallback.
@coderabbitai

coderabbitai Bot commented Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

Next included review available in 55 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 2 included reviews currently available. Your 51 included PR review attempts over the past 7 days set your current allowance at 2 reviews per hour.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Essentials
  • Run ID: e3f12cdf-7bf7-4fad-be2b-6291aa6c4034
📥 Commits

Reviewing files that changed from the base of the PR and between ab10066 and 1555489.

📒 Files selected for processing (4)
  • .github/workflows/ci.yml
  • .github/workflows/release.yml
  • apps/docs/src/content/contributing/chrome-extension.md
  • apps/docs/src/content/contributing/publishing.md
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@github-actions github-actions Bot added area: docs The documentation site area: ci Workflows, hooks and repository tooling labels Sep 30, 2026
@nx-cloud

nx-cloud Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 1555489

Command Status Duration Result
nx affected -t test build ✅ Succeeded 1m 13s View ↗

💡 Verify your cache is correct by running tasks in a sandbox. Read docs ↗


☁️ Nx Cloud last updated this comment at 2026-10-03 13:49:56 UTC

Also adapts the release to main: Release bumps the extension manifest
and the docs banners with the package, the changelog check accepts a
heading without a date, a rerun stops when the tag already exists
instead of moving it, CI called from Release compares against its own
last run, and publishing.md matches.
@erkamyaman
erkamyaman marked this pull request as ready for review October 3, 2026 13:47
@erkamyaman
erkamyaman marked this pull request as draft October 3, 2026 13:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: ci Workflows, hooks and repository tooling area: docs The documentation site

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant