@anolilab/semantic-release-preset 2.2.0 → 2.2.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.
Files changed (4) hide show
  1. package/.releaserc-with-npm.json +1 -1
  2. package/CHANGELOG.md +9 -0
  3. package/README.md +207 -0
  4. package/package.json +9 -9
package/.releaserc-with-npm.json CHANGED
@@ -27,7 +27,7 @@
27
27
  }
28
28
  ],
29
29
  "@semantic-release/changelog",
30
- "@semrel-extra/npm",
30
+ "@semantic-release/npm",
31
31
  [
32
32
  "@semantic-release/git",
33
33
  {
package/CHANGELOG.md CHANGED
@@ -1,3 +1,12 @@
1
+ ## @anolilab/semantic-release-preset [2.2.1](https://github.com/anolilab/javascript-style-guide/compare/@anolilab/semantic-release-preset@2.2.0...@anolilab/semantic-release-preset@2.2.1) (2023-05-25)
2
+
3
+
4
+ ### Bug Fixes
5
+
6
+ * changed @semrel-extra/npm to @semantic-release/npm because of esm support ([f76c2d4](https://github.com/anolilab/javascript-style-guide/commit/f76c2d4349acc74498ea75f123d2718025515708))
7
+ * switched @semrel-extra/npm to @semantic-release/npm and added new example to the readme ([040da7b](https://github.com/anolilab/javascript-style-guide/commit/040da7bd69e5d9fd8a830b03cc59abdecd7dd3fc))
8
+ * updated package deps ([34e24a0](https://github.com/anolilab/javascript-style-guide/commit/34e24a097c282f0b032a283225a1d91439b3f08e))
9
+
1
10
  ## @anolilab/semantic-release-preset [2.2.0](https://github.com/anolilab/javascript-style-guide/compare/@anolilab/semantic-release-preset@2.1.0...@anolilab/semantic-release-preset@2.2.0) (2023-01-14)
2
11
 
3
12
 
package/README.md CHANGED
@@ -142,6 +142,9 @@ What you’ll want to do next is configure a [GitHub workflow](https://docs.git
142
142
 
143
143
  Here’s an example workflow configuration that runs your tests and publishes a new version for new commits on `main` branch:
144
144
 
145
+ <details>
146
+ <summary>Single semantic-release example with yarn</summary>
147
+
145
148
  ```yaml
146
149
  # https://help.github.com/en/categories/automating-your-workflow-with-github-actions
147
150
 
@@ -250,6 +253,210 @@ jobs:
250
253
  GIT_COMMITTER_EMAIL: "github-actions[bot]@users.noreply.github.com"
251
254
  run: "yarn semantic-release"
252
255
  ```
256
+ </details>
257
+
258
+ To release multi package repositories, you need to install `@qiwi/multi-semantic-release` and `semantic-release`.
259
+
260
+ <details>
261
+ <summary>Multi package semantic-release example with pnpm</summary>
262
+
263
+ ```yaml
264
+ # https://help.github.com/en/categories/automating-your-workflow-with-github-actions
265
+
266
+ name: "Semantic Release"
267
+
268
+ on: # yamllint disable-line rule:truthy
269
+ push:
270
+ branches:
271
+ - "([0-9])?(.{+([0-9]),x}).x"
272
+ - "main"
273
+ - "next"
274
+ - "next-major"
275
+ - "alpha"
276
+ - "beta"
277
+
278
+ # Enable this to use the github packages
279
+ # yamllint disable-line rule:comments
280
+ #env:
281
+ # package: "@${{ github.repository }}"
282
+ # registry_url: "https://npm.pkg.github.com"
283
+ # scope: "${{ github.repository_owner }}"
284
+
285
+ jobs:
286
+ test:
287
+ strategy:
288
+ matrix:
289
+ os: ["ubuntu-latest"]
290
+ node_version: ["16", "18", "19", "20"]
291
+ fail-fast: false
292
+
293
+ name: "Build & Unit Test: node-${{ matrix.node_version }}, ${{ matrix.os }}"
294
+
295
+ runs-on: "${{ matrix.os }}"
296
+
297
+ steps:
298
+ - name: "Git checkout"
299
+ uses: "actions/checkout@v3"
300
+ env:
301
+ GIT_COMMITTER_NAME: "GitHub Actions Shell"
302
+ GIT_AUTHOR_NAME: "GitHub Actions Shell"
303
+ EMAIL: "github-actions[bot]@users.noreply.github.com"
304
+
305
+ - uses: "pnpm/action-setup@v2.2.4"
306
+ with:
307
+ version: 7
308
+ run_install: false
309
+
310
+ - name: "Set node version to ${{ matrix.node_version }}"
311
+ uses: "actions/setup-node@v3"
312
+ with:
313
+ node-version: "${{ matrix.node_version }}"
314
+ cache: "pnpm"
315
+
316
+ - name: "Get pnpm store directory"
317
+ id: "pnpm-cache"
318
+ run: |
319
+ echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
320
+
321
+ - uses: "actions/cache@v3"
322
+ name: "Setup pnpm cache"
323
+ with:
324
+ path: "${{ steps.pnpm-cache.outputs.STORE_PATH }}"
325
+ key: "${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}"
326
+ restore-keys: |
327
+ ${{ runner.os }}-pnpm-store-
328
+
329
+ # @see: https://github.com/pnpm/pnpm/issues/4348
330
+ - name: "Upgrade npm to 8.4 version"
331
+ run: "npm install --global npm@8.4"
332
+ env:
333
+ SKIP_CHECK: "true"
334
+
335
+ - name: "Check npm version"
336
+ run: "npm -v"
337
+ env:
338
+ SKIP_CHECK: "true"
339
+
340
+ - name: "Install packages"
341
+ run: "pnpm install --frozen-lockfile"
342
+ env:
343
+ SKIP_CHECK: "true"
344
+
345
+ - name: "Build"
346
+ run: "pnpm run build:packages"
347
+
348
+ - name: "test and coverage"
349
+ run: "pnpm run test:coverage"
350
+
351
+ semantic-release:
352
+ name: "Semantic Release"
353
+
354
+ runs-on: "ubuntu-latest"
355
+
356
+ needs: ["test", "eslint"]
357
+
358
+ steps:
359
+ - name: "Git checkout"
360
+ uses: "actions/checkout@v3"
361
+ with:
362
+ fetch-depth: 0
363
+ persist-credentials: false
364
+ env:
365
+ GIT_COMMITTER_NAME: "GitHub Actions Shell"
366
+ GIT_AUTHOR_NAME: "GitHub Actions Shell"
367
+ EMAIL: "github-actions[bot]@users.noreply.github.com"
368
+
369
+ - uses: "pnpm/action-setup@v2.2.4"
370
+ with:
371
+ version: 7
372
+ run_install: false
373
+
374
+ - name: "Use Node.js 16.x"
375
+ uses: "actions/setup-node@v3"
376
+ with:
377
+ node-version: "16.x"
378
+ cache: "pnpm"
379
+
380
+ - name: "Get pnpm store directory"
381
+ id: "pnpm-cache"
382
+ run: |
383
+ echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
384
+
385
+ - uses: "actions/cache@v3"
386
+ name: "Setup pnpm cache"
387
+ with:
388
+ path: "${{ steps.pnpm-cache.outputs.STORE_PATH }}"
389
+ key: "${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}"
390
+ restore-keys: |
391
+ ${{ runner.os }}-pnpm-store-
392
+
393
+ # @see: https://github.com/pnpm/pnpm/issues/4348
394
+ - name: "Upgrade npm to 8.4 version"
395
+ run: "npm install --global npm@8.4"
396
+ env:
397
+ SKIP_CHECK: "true"
398
+
399
+ - name: "Check npm version"
400
+ run: "npm -v"
401
+ env:
402
+ SKIP_CHECK: "true"
403
+
404
+ - name: "Install packages"
405
+ run: "pnpm install --frozen-lockfile"
406
+
407
+ - name: "Build Production"
408
+ run: "pnpm run build:prod:packages"
409
+
410
+ - name: "Semantic Release"
411
+ if: "success()"
412
+ env:
413
+ GITHUB_TOKEN: "${{ secrets.SEMANTIC_RELEASE_GITHUB_TOKEN }}"
414
+ NPM_TOKEN: "${{ secrets.NPM_AUTH_TOKEN }}"
415
+ GIT_AUTHOR_NAME: "github-actions-shell"
416
+ GIT_AUTHOR_EMAIL: "github-actions[bot]@users.noreply.github.com"
417
+ GIT_COMMITTER_NAME: "github-actions-shell"
418
+ GIT_COMMITTER_EMAIL: "github-actions[bot]@users.noreply.github.com"
419
+ run: "pnpm multi-semantic-release"
420
+
421
+ pnpm-lock-update:
422
+ name: "pnpm-lock.yaml update"
423
+
424
+ runs-on: "ubuntu-latest"
425
+
426
+ needs: ["semantic-release"]
427
+
428
+ steps:
429
+ - name: "Git checkout"
430
+ uses: "actions/checkout@v3"
431
+ with:
432
+ fetch-depth: 2
433
+ env:
434
+ GIT_COMMITTER_NAME: "GitHub Actions Shell"
435
+ GIT_AUTHOR_NAME: "GitHub Actions Shell"
436
+ EMAIL: "github-actions[bot]@users.noreply.github.com"
437
+
438
+ - uses: "pnpm/action-setup@v2.2.4"
439
+ with:
440
+ version: 7
441
+
442
+ - name: "Use Node.js 16.x"
443
+ uses: "actions/setup-node@v3"
444
+ with:
445
+ node-version: "16.x"
446
+
447
+ - name: "Update pnpm lock"
448
+ run: "pnpm install --no-frozen-lockfile"
449
+
450
+ - name: "Commit modified files"
451
+ uses: "stefanzweifel/git-auto-commit-action@v4.16.0"
452
+ with:
453
+ commit_message: "chore: updated pnpm-lock.yaml"
454
+ commit_author: "prisis <d.bannert@anolilab.de>"
455
+ commit_user_email: "d.bannert@anolilab.de"
456
+ commit_user_name: "prisis"
457
+ branch: "${{ github.head_ref }}"
458
+ ```
459
+ </details>
253
460
 
254
461
  ## Note on GitHub protected branches
255
462
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@anolilab/semantic-release-preset",
3
- "version": "2.2.0",
3
+ "version": "2.2.1",
4
4
  "description": "Anolilab Coding Standard for semantic-release.",
5
5
  "keywords": [
6
6
  "anolilab",
@@ -48,23 +48,23 @@
48
48
  "postinstall": "node lib/postinstall.js"
49
49
  },
50
50
  "dependencies": {
51
- "@commitlint/cli": "^17.4.2",
52
- "@commitlint/config-conventional": "^17.4.2",
53
- "@commitlint/core": "^17.4.2",
54
- "@semantic-release/changelog": "^6.0.2",
51
+ "@commitlint/cli": "^17.6.3",
52
+ "@commitlint/config-conventional": "^17.6.3",
53
+ "@commitlint/core": "^17.6.3",
54
+ "@semantic-release/changelog": "^6.0.3",
55
55
  "@semantic-release/commit-analyzer": "^9.0.2",
56
56
  "@semantic-release/exec": "^6.0.3",
57
57
  "@semantic-release/git": "^10.0.1",
58
58
  "@semantic-release/github": "^8.0.7",
59
- "@semantic-release/release-notes-generator": "^10.0.3",
60
- "@semrel-extra/npm": "^1.2.2",
61
- "commitizen": "^4.2.6",
59
+ "@semantic-release/release-notes-generator": "^11.0.1",
60
+ "@semantic-release/npm": "^10.0.3",
61
+ "commitizen": "^4.3.0",
62
62
  "conventional-changelog-conventionalcommits": "^5.0.0",
63
63
  "cz-conventional-changelog": "^3.3.0",
64
64
  "semantic-release-conventional-commits": "^3.0.0"
65
65
  },
66
66
  "devDependencies": {
67
- "semantic-release": "^20.0.2"
67
+ "semantic-release": "^21.0.2"
68
68
  },
69
69
  "peerDependencies": {
70
70
  "semantic-release": "^19.0.5"