@halospv3/hce.shared-config 2.0.1 → 2.1.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [2.1.0](https://github.com/halospv3/hce.shared/compare/v2.0.1...v2.1.0) (2024-03-18)
+
+
+### Features
+
+* add plugin '@semantic-release/exec' ([61447fc](https://github.com/halospv3/hce.shared/commit/61447fcdef19db8cd7f103edd54354fa5c4cb202))
+
 ## [2.0.1](https://github.com/halospv3/hce.shared/compare/v2.0.0...v2.0.1) (2024-03-18)
 
 

package/README.md

@@ -15,13 +15,32 @@ npm install --save-dev @halospv3/hce.shared-config
 
 ### 2. Customize Semantic Release
 
-   WARNING! Defining a property will *overwrite* the previous value. Arrays and objects are *not* merged. You can...
-    - Assign to top-level variables to avoid modifying the plugins array.
-    - Write your config in CJS to manually merge objects and arrays.
-
-   Configs:
-    - `hce.shared-config`: [static/.releaserc.yml](static/.releaserc.yml)
-    - [dotnet/.releaserc.cjs](dotnet/.releaserc.cjs) based on [BinToss/GroupBox.Avalonia's Semantic Release config](https://github.com/BinToss/GroupBox.Avalonia).
+WARNING! Defining a property will *overwrite* the previous value. Arrays and objects are *not* merged. You can...
+- Assign to top-level variables to avoid modifying the plugins array.
+- Write your config in CJS and manually merge objects and arrays.
+
+**Configs**
+- `hce.shared-config`: [static/.releaserc.yml](static/.releaserc.yml)
+- [dotnet/.releaserc.cjs](dotnet/.releaserc.cjs) based on [BinToss/GroupBox.Avalonia's Semantic Release config](https://github.com/BinToss/GroupBox.Avalonia).
+
+**Notable Plugin Properties**
+- [`@semantic-release/commit-analyzer`](https://github.com/semantic-release/commit-analyzer#options)
+  - preset (set to conventionalcommits)
+  - parserOpts
+  - releaseRules
+- [`@semantic-release/release-notes-generator`](https://github.com/semantic-release/release-notes-generator#options)
+  - preset (set to conventionalcommits)
+  - parserOpts
+  - writerOpts
+- [`@semantic-release/changelog`](https://github.com/semantic-release/changelog#options)
+  - changelogFile (default: CHANGELOG.md)
+- [`@semantic-release/git`](https://github.com/semantic-release/git#options)
+  - assets (default: ['CHANGELOG.md', 'package.json', 'package-lock.json', 'npm-shrinkwrap.json'])
+- `@semantic-release/exec`
+  - prepareCmd
+- [`@semantic-release/github`](https://github.com/semantic-release/github#options)
+  - assets
+  - draftRelease (default: false)
 
 ### 3. Set Up CommitLint
 

package/dotnet/.releaserc.cjs

@@ -25,8 +25,8 @@ if (process.argv.includes("--debug") || process.argv.includes("--verbose")) {
 const newPlugins = hceSharedConfig.plugins;
 
 //#region Insert-Edit Plugins
-/* Insert and/or configure plugins. Can be used to load plugin A before plugin B
-or edit a plugin's existing configuration */
+/* Insert and/or configure plugins. Can be used to load plugin A's Prepare step
+before plugin B's Prepare step. or edit a plugin's existing configuration */
 for (var i = 0; i < newPlugins.length; i++) {
   /** e.g.
   //#region Git Options | https://github.com/semantic-release/git#options

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@halospv3/hce.shared-config",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Automate commit message quality, changelogs, and CI/CD releases. Exports a semantic-release shareable configuration deserialized from this package's '.releaserc.yml'. Shared resources for .NET projects are also distributed with this package.",
   "keywords": [
     "halo",
@@ -45,6 +45,7 @@
     "@commitlint/config-conventional": "^19.1.0",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/commit-analyzer": "^12.0.0",
+    "@semantic-release/exec": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/github": "^10.0.2",
     "@semantic-release/npm": "^12.0.0",

package/static/.releaserc.yml

@@ -20,13 +20,17 @@ plugins: # https://semantic-release.gitbook.io/semantic-release/v/beta/usage/con
     - assets:
         - README.md
         - CHANGELOG.md
+  # Arbitrary shell commands - https://github.com/semantic-release/exec
+  # hint: set 'prepareCmd' to `dotnet publish`. This can be a top-level property!
+  #   Because this is sorted after @semantic-release/git, the new Git tag will 
+  #   be visible to dotnet (and GitVersion). Dotnet artifacts will be
+  #   versioned accordingly.
+  # Plugins' Steps: https://github.com/semantic-release/semantic-release/blob/master/docs/extending/plugins-list.md
+  - "@semantic-release/exec"
   - - "@semantic-release/github"
     - assets:
         - path: ./publish/*
-## (OPTIONAL) update Version strings
+
+## (OPTIONAL) update static Version strings.
 # https://github.com/jpoehnelt/semantic-release-replace-plugin
 # https://github.com/droidsolutions/semantic-release-update-file
-
-## Arbitrary shell commands
-# (useful for `dotnet publish publish/`, but should be run after version tag is pushed so InformationalVersionInfo isn't a subversion)
-# https://github.com/semantic-release/exec