voidflow 0.0.0 → 0.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -76,6 +76,11 @@ import { definePreviewConfig } from '@taraxvoid/voidflow/playwright'
76
76
  export default definePreviewConfig({ ciPort: 4141 })
77
77
  ```
78
78
 
79
+ The same release is also published unscoped as `voidflow` (identical
80
+ contents and version), so `bun add -d voidflow` and
81
+ `import ... from 'voidflow/playwright'` work too. `@taraxvoid/voidflow` is the
82
+ canonical name.
83
+
79
84
  Options: `ciPort` (required in CI), `runner` (default `bun`, e.g. `pnpm`),
80
85
  `timeout` (default 30000), `projects` (default Pixel 7 and Desktop Chrome),
81
86
  `testDir` (default `./test/e2e`). Requires `@playwright/test` in the site.
@@ -110,20 +115,17 @@ jobs:
110
115
 
111
116
  ### Versioning
112
117
 
113
- This project uses semver, released manually in two steps (`main` requires PRs, so nothing
114
- can push straight to it — not even Actions):
115
-
116
- 1. Dispatch [`release.yml`](.github/workflows/release.yml) (`workflow_dispatch`, with a
117
- `version` input) — it regenerates [`CHANGELOG.md`](CHANGELOG.md) via git-cliff, validates,
118
- and opens a `chore(release): prepare for vX.Y.Z` PR.
119
- 2. Merging that PR triggers [`tag-release.yml`](.github/workflows/tag-release.yml), which
120
- tags the merge commit and publishes the GitHub release. (Tag pushes aren't covered by
121
- `main`'s branch protection, only branch pushes are.)
118
+ This project uses semver, released with [release-please](https://github.com/googleapis/release-please)
119
+ ([`release-please.yml`](.github/workflows/release-please.yml)). It keeps a standing
120
+ `chore(release): X.Y.Z` PR open against `main`, updated as commits land. Merging it bumps
121
+ `package.json` and [`CHANGELOG.md`](CHANGELOG.md), tags `vX.Y.Z`, creates the GitHub release,
122
+ and publishes to npm. The PR is opened with the org's release-bot GitHub App token
123
+ (`RELEASE_BOT_CLIENT_ID` / `RELEASE_BOT_APP_PRIVATE_KEY`) so CI runs on it.
122
124
 
123
125
  Commit messages should follow [Conventional Commits](https://www.conventionalcommits.org) —
124
126
  enforced loosely, as an advisory `commit-msg` hint (see
125
127
  [`scripts/check-commit-msg.sh`](scripts/check-commit-msg.sh)), not a blocking check. They
126
- drive the generated changelog.
128
+ drive the version bump and generated changelog.
127
129
 
128
130
  Treat `@main` as unstable. Consumers should pin to an exact release tag, e.g. `@v0.3.0` —
129
131
  there is no floating major-version tag (`@v1`) to track yet.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "voidflow",
3
- "version": "0.0.0",
3
+ "version": "0.8.1",
4
4
  "description": "Shared workflows, actions and tooling for @taraxvoid sites",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -1,3 +1,4 @@
1
+ // @ts-self-types="./index.d.mts"
1
2
  /*
2
3
  * Shared Playwright config for Astro sites that e2e against `astro preview`.
3
4
  *