Release `@push-based/create-ngp`, and verify `vp create @push-based/ngp` after each release

Open
  • Is something wrong?
#18 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
24/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
github-actions, typescript
Domain
ci-cd, release, testing

Research direction

Start with nx.json, publish.yml, docs/releasing.md, and the existing plugin release configuration; confirm how Nx projects feed commit scopes. Then trace the publish workflow and package prepack checks, and review the proposed vp create commands and scheduled latest-version run. Done means the package is released with the plugin's version, release documentation is updated, and the post-publish and weekly E2E checks cover both templates, including the SSR server request.

Written by the indexing model from the issue text.

Description

feature

Part of #13. Labels: feature.

Release

  • Add the package to nx.json#release.projects. projectsRelationship: fixed keeps it on the plugin's version, which is what the template's pins need: a template at x.y.z scaffolds the plugin at x.y.z.
  • Commit scope: create-ngp joins the allowed scopes (commitlint reads them from Nx projects via @commitlint/config-nx-scopes, so naming the Nx projects is enough; confirm).
  • The Publish workflow publishes both packages through trusted publishing. The new package needs its first version published by hand and the trusted publisher added on npmjs.com, as docs/releasing.md describes for the plugin; extend that page.
  • @push-based/create-ngp has no native engine, so it doesn't need the four runners; prepack only checks that versions.json matches the plugin's package.json.

E2E after publish

A job at the end of publish.yml, after npm confirms the version: on a fresh runner with vite-plus installed globally (voidzero-dev/setup-vp), run

vp create @push-based/ngp e2e -- --no-interactive --template app
cd e2e && vp build && vp test run

and the same for app-ssr with a request to the started server. It uses the version just published, so it catches a template that pins a plugin version npm doesn't have yet. It also runs on a schedule weekly against latest, because Vite+ releases change the post-create rewrite (two such changes landed between March and June 2026).

Document the job in docs/releasing.md and the bench/CI note in docs/building.md if the toolchain is involved (it isn't: this job installs from npm).

Dominant language
TypeScript
Stars
7
Forks
1
Avg merge
12h 24m
Merged PRs (30d)
13

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from push-based/vite-plugin-ngp

All issues in push-based/vite-plugin-ngp

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.