@peiyanlu/release 0.0.8 → 0.0.10

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
@@ -296,18 +296,63 @@ GitHub Release 可基于 Git Tag 自动创建,并支持附带:
296
296
  当 Tag 推送到远端后,CI/CD 自动执行:
297
297
 
298
298
  - 发布到 npm
299
- - 创建 GItHub release
299
+ - 创建 GitHub Release
300
300
 
301
+ ### 示例用法
302
+
303
+ - 发布到 npm
301
304
  ```ts
302
305
  // publishCI.ts
306
+
303
307
  import { publishTagToNpm } from '@peiyanlu/release'
308
+ await publishTagToNpm({})
309
+ ```
304
310
 
311
+ ```json5
312
+ // package.json
305
313
 
306
- await publishTagToNpm({
307
- gitTag: '1.0.16',
308
- getPkgDir: () => '.',
309
- defaultPackage: '.',
310
- })
314
+ {
315
+ "scripts": {
316
+ "ci-publish": "tsx src/publishCI.ts"
317
+ }
318
+ }
319
+ ```
320
+
321
+ ```yaml
322
+ # .github/workflows/publish.yml
323
+
324
+ jobs:
325
+ publish:
326
+ name: Publish
327
+ runs-on: ubuntu-latest
328
+
329
+ steps:
330
+ - name: Publish
331
+ run: npm i -g npm@^11.5.2 && pnpm run ci-publish "$REF_NAME"
332
+ env:
333
+ REF_NAME: ${{ github.ref_name }}
334
+ ```
335
+
336
+ - 创建 GitHub Release
337
+ ```yaml
338
+ # .github/workflows/release.yml
339
+
340
+ jobs:
341
+ release:
342
+ name: Release
343
+ runs-on: ubuntu-latest
344
+
345
+ steps:
346
+ - name: Release
347
+ uses: peiyanlu/release
348
+ env:
349
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
350
+ with:
351
+ tag_name: ${{ github.ref_name }}
352
+ release_name: Release ${{ github.ref_name }}
353
+ body: |
354
+ Please refer to [CHANGELOG.md](./CHANGELOG.md) for details.
355
+ draft: false
311
356
  ```
312
357
 
313
358
  ## Dry Run
package/dist/index.mjs CHANGED
@@ -219,6 +219,7 @@ const publishTagToNpm = async (options) => {
219
219
  [pkgName, version] = tag.split(tagSeparator);
220
220
  console.log(`🔍 Parsed tag → package: "${yellow(pkgName)}", version: "${green(version)}"`);
221
221
  } else {
222
+ pkgName = ".";
222
223
  version = tag;
223
224
  console.log(`🔍 Parsed tag → version only: "${green(version)}"`);
224
225
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@peiyanlu/release",
3
- "version": "0.0.8",
3
+ "version": "0.0.10",
4
4
  "description": "Release project tool.",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -26,6 +26,8 @@
26
26
  "test:cov": "vitest run --coverage"
27
27
  },
28
28
  "dependencies": {
29
+ "@actions/core": "^3.0.0",
30
+ "@actions/github": "^9.0.0",
29
31
  "@clack/prompts": "^1.2.0",
30
32
  "@octokit/rest": "^22.0.1",
31
33
  "@peiyanlu/cli-utils": "^0.0.8",