nx-semantic-release

semantic-release plugin to prepare workspace apps using nx's affected: tool.

| Step | Description | |--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | prepare | Run nx affected over desired targets before publishing. |

Install

$ npm install nx-semantic-release -D

Usage

The plugin can be configured in the semantic-release configuration file:

{
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    "nx-semantic-release"
  ]
}

Options

| Option | Description | Default | |-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| | targets | An array of targets to run nx affected: against. | [] | | projects | An array of projects to whitelist. | [] (if empty, will run against any affected projects) | | customCommands | Array of additional commands to run on affected projects (command will be passed a $project variable) | [] | | extraArgs | Additional arguments to pass to the affected: commands | [] |

Detailed Usage

The plugin can be configured in the semantic-release configuration file:

{
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    [
      "nx-semantic-release",
      {
        "targets": ["build"],
        "extraArgs": ["--prod", "--stats-json"],
        "customCommands": ["npm run genBundleReports -- --$project"]
      }
    ]
  ]
}