Skip to content

Commit 7ca84e1

Browse files
dianjuarcursoragent
andcommitted
docs: revert README changes from release PR
Keep README on main; release docs stay in README_contributors only. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 677dec7 commit 7ca84e1

1 file changed

Lines changed: 5 additions & 14 deletions

File tree

README.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -182,30 +182,23 @@ This repo publishes with OIDC in [`.github/workflows/publishment.yml`](.github/w
182182

183183
### GitHub Actions with `@jscutlery/semver` <a name="github-actions-with-jscutlerysemver"></a> <!-- omit in toc -->
184184

185-
[`@jscutlery/semver`](https://github.com/jscutlery/semver) bumps the version from your commits and can chain **build**, **deploy**, and **GitHub releases** via `postTargets`. Configure a `version` target on your library (see [this repo's `project.json`](https://github.com/bikecoders/ngx-deploy-npm/blob/main/packages/ngx-deploy-npm/project.json)):
185+
[`@jscutlery/semver`](https://github.com/jscutlery/semver) bumps the version from your commits and can chain **build** and **deploy** via `postTargets`. Configure a `version` target on your library (see [this repo's `project.json`](https://github.com/bikecoders/ngx-deploy-npm/blob/main/packages/ngx-deploy-npm/project.json)):
186186

187187
```json
188-
"github": {
189-
"executor": "@jscutlery/semver:github",
190-
"options": {
191-
"tag": "{tag}",
192-
"notes": "{notes}"
193-
}
194-
},
195188
"version": {
196189
"executor": "@jscutlery/semver:version",
197190
"options": {
198-
"postTargets": ["build", "deploy", "github"]
191+
"postTargets": ["build", "deploy"]
199192
}
200193
}
201194
```
202195

203-
In CI, a single command bumps, builds, publishes to npm, and creates a GitHub release:
196+
In CI, a single command bumps, builds, and publishes:
204197

205198
```yaml
206199
permissions:
207200
id-token: write # omit if using NPM_TOKEN instead (see below)
208-
contents: write # required for @jscutlery/semver:github
201+
contents: read
209202
210203
steps:
211204
- uses: actions/checkout@v6
@@ -216,8 +209,6 @@ steps:
216209
node-version: '22'
217210
- run: npm ci
218211
- run: npx nx version your-library
219-
env:
220-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
221212
```
222213

223214
### GitHub Actions with an NPM token <a name="github-actions-with-an-npm-token"></a> <!-- omit in toc -->
@@ -469,7 +460,7 @@ We strongly recommend using [`@jscutlery/semver`](https://github.com/jscutlery/s
469460

470461
For more information go to semver's [documentation](https://github.com/jscutlery/semver#triggering-executors-post-release)
471462

472-
We use `@jscutlery/semver` here on `ngx-deploy-npm` to generate the package's next version, create a [GitHub release](https://github.com/bikecoders/ngx-deploy-npm/releases), and publish that version to npm with `ngx-deploy-npm`. Yes, it uses itself — see [ngx-deploy-npm/project.json](https://github.com/bikecoders/ngx-deploy-npm/blob/main/packages/ngx-deploy-npm/project.json).
463+
We use `@jscutlery/semver` here on `ngx-deploy-npm` to generate the package's next version, and we use `ngx-deploy-npm` to publish that version to NPM. Yes, it uses itself, take a look by yourself [ngx-deploy-npm/project.json](https://github.com/bikecoders/ngx-deploy-npm/blob/main/packages/ngx-deploy-npm/project.json#L55-L67)
473464

474465
### One library per install run <!-- omit in toc -->
475466

0 commit comments

Comments
 (0)