npmpackage.info

Gathering detailed insights and metrics for @semantic-release/exec

Other packages similar to @semantic-release/exec

semantic-release

24.2.0

Automated semver compliant package publishing

@semantic-release/github

11.0.1

semantic-release plugin to publish a GitHub release and comment on released Pull Requests/Issues

@semantic-release/error

4.0.0

errors with more than just a message

@semantic-release/npm

12.0.1

semantic-release plugin to publish a npm package

Gathering detailed insights and metrics for @semantic-release/exec

@semantic-release/exec

🐚 semantic-release plugin to execute custom shell commands

6.0.3

136

MIT

JavaScript

52.75 kB

39,040,104 4.7

Installations

npm install @semantic-release/exec

Pull Requests

Open

16

Total

360

Closed

30

Merged

314

Issues

Open

22

Total

54

Closed

32

Releases

v7.0.0-beta.1

Published on 18 Nov 2024

v6.0.3

Published on 15 Dec 2021

v6.0.2

Published on 30 Oct 2021

v6.0.1

Published on 21 Sept 2021

v6.0.0

Published on 21 Sept 2021

v5.0.0

Published on 27 Jan 2020

View all 47 releases

Developer

semantic-release

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=14.17

Typescript Support

No

Node Version

16.13.1

NPM Version

7.24.2 Statistics

136 Stars

339 Commits

26 Forks

5 Watching

17 Branches

18 Contributors

Updated on 17 Nov 2024

Bundle Size

144.19 kB

Minified

52.75 kB

Minified + Gzipped

Bundlephobia

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

39,040,104

Last day

11.7%

76,045

Compared to previous day

Last week

7.6%

379,380

Compared to previous week

Last month

13.9%

1,534,371

Compared to previous month

Last year

34.4%

13,960,939

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

@semantic-release/exec

semantic-release plugin to execute custom shell commands.

Step	Description
`verifyConditions`	Execute a shell command to verify if the release should happen.
`analyzeCommits`	Execute a shell command to determine the type of release.
`verifyRelease`	Execute a shell command to verifying a release that was determined before and is about to be published.
`generateNotes`	Execute a shell command to generate the release note.
`prepare`	Execute a shell command to prepare the release.
`publish`	Execute a shell command to publish the release.
`success`	Execute a shell command to notify of a new release.
`fail`	Execute a shell command to notify of a failed release.

Install

1$ npm install @semantic-release/exec -D

Usage

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

1{
2  "plugins": [
3    "@semantic-release/commit-analyzer",
4    "@semantic-release/release-notes-generator",
5    ["@semantic-release/exec", {
6      "verifyConditionsCmd": "./verify.sh",
7      "publishCmd": "./publish.sh ${nextRelease.version} ${branch.name} ${commits.length} ${Date.now()}"
8    }],
9  ]
10}

With this example:

the shell command ./verify.sh will be executed on the verify conditions step
the shell command ./publish.sh 1.0.0 master 3 870668040000 (for the release of version 1.0.0 from branch master with 3 commits on August 4th, 1997 at 2:14 AM) will be executed on the publish step

Note: it's required to define a plugin for the analyze commits step. If no analyzeCommitsCmd is defined the plugin @semantic-release/commit-analyzer must be defined in the plugins list.

Configuration

Options

Options	Description
`verifyConditionsCmd`	The shell command to execute during the verify condition step. See verifyConditionsCmd.
`analyzeCommitsCmd`	The shell command to execute during the analyze commits step. See analyzeCommitsCmd.
`verifyReleaseCmd`	The shell command to execute during the verify release step. See verifyReleaseCmd.
`generateNotesCmd`	The shell command to execute during the generate notes step. See generateNotesCmd.
`prepareCmd`	The shell command to execute during the prepare step. See prepareCmd.
`addChannelCmd`	The shell command to execute during the add channel step. See addChannelCmd.
`publishCmd`	The shell command to execute during the publish step. See publishCmd.
`successCmd`	The shell command to execute during the success step. See successCmd.
`failCmd`	The shell command to execute during the fail step. See failCmd.
`shell`	The shell to use to run the command. See execa#shell.
`execCwd`	The path to use as current working directory when executing the shell commands. This path is relative to the path from which semantic-release is running. For example if semantic-release runs from `/my-project` and `execCwd` is set to `buildScripts` then the shell command will be executed from `/my-project/buildScripts`

Each shell command is generated with Lodash template. All the objects passed to the semantic-release plugins are available as template options.

verifyConditionsCmd

Execute a shell command to verify if the release should happen.

Command property	Description
`exit code`	`0` if the verification is successful, or any other exit code otherwise.
`stdout`	Write only the reason for the verification to fail.
`stderr`	Can be used for logging.

analyzeCommitsCmd

Command property	Description
`exit code`	Any non `0` code is considered as an unexpected error and will stop the `semantic-release` execution with an error.
`stdout`	Only the release type (`major`, `minor` or `patch` etc..) can be written to `stdout`. If no release has to be done the command must not write to `stdout`.
`stderr`	Can be used for logging.

verifyReleaseCmd

Command property	Description
`exit code`	`0` if the verification is successful, or any other exit code otherwise.
`stdout`	Only the reason for the verification to fail can be written to `stdout`.
`stderr`	Can be used for logging.

generateNotesCmd

Command property	Description
`exit code`	Any non `0` code is considered as an unexpected error and will stop the `semantic-release` execution with an error.
`stdout`	Only the release note must be written to `stdout`.
`stderr`	Can be used for logging.

prepareCmd

Command property	Description
`exit code`	Any non `0` code is considered as an unexpected error and will stop the `semantic-release` execution with an error.
`stdout`	Can be used for logging.
`stderr`	Can be used for logging.

addChannelCmd

Command property	Description
`exit code`	Any non `0` code is considered as an unexpected error and will stop the `semantic-release` execution with an error.
`stdout`	The `release` information can be written to `stdout` as parseable JSON (for example `{"name": "Release name", "url": "http://url/release/1.0.0"}`). If the command write non parseable JSON to `stdout` no `release` information will be returned.
`stderr`	Can be used for logging.

publishCmd

Command property	Description
`exit code`	Any non `0` code is considered as an unexpected error and will stop the `semantic-release` execution with an error.
`stdout`	The `release` information can be written to `stdout` as parseable JSON (for example `{"name": "Release name", "url": "http://url/release/1.0.0"}`). If the command write non parseable JSON to `stdout` no `release` information will be returned.
`stderr`	Can be used for logging.

successCmd

Command property	Description
`exit code`	Any non `0` code is considered as an unexpected error and will stop the `semantic-release` execution with an error.
`stdout`	Can be used for logging.
`stderr`	Can be used for logging.

failCmd

Command property	Description
`exit code`	Any non `0` code is considered as an unexpected error and will stop the `semantic-release` execution with an error.
`stdout`	Can be used for logging.
`stderr`	Can be used for logging.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

1

Maintained

Determines if the project is "actively maintained".

1

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

4.7

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @semantic-release/exec

Other packages similar to @semantic-release/exec

@semantic-release/exec

Installations

Pull Requests

16

360

30

314

Issues

22

54

32

Releases

Developer

semantic-release

Developer Guide

CommonJS

>=14.17

No

16.13.1

7.24.2

Statistics

Bundle Size

144.19 kB

52.75 kB

Languages

Total Downloads

39,040,104

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

@semantic-release/exec

Install

Usage

Configuration

Options

verifyConditionsCmd

analyzeCommitsCmd

verifyReleaseCmd

generateNotesCmd

prepareCmd

addChannelCmd

publishCmd

successCmd

failCmd

10

10

10

10

10

10

1

1

0

0

0

0

0

4.7

/10