semantic-release 25.0.5 → 25.0.6

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 (40) hide show
  1. package/README.md +36 -30
  2. package/bin/semantic-release.js +1 -1
  3. package/lib/definitions/errors.js +38 -33
  4. package/lib/hide-sensitive.js +14 -1
  5. package/package.json +20 -15
  6. package/docs/README.md +0 -7
  7. package/docs/developer-guide/README.md +0 -5
  8. package/docs/developer-guide/js-api.md +0 -294
  9. package/docs/developer-guide/plugin.md +0 -284
  10. package/docs/developer-guide/shareable-configuration.md +0 -1
  11. package/docs/extending/README.md +0 -4
  12. package/docs/extending/plugins-list.md +0 -233
  13. package/docs/extending/shareable-configurations-list.md +0 -22
  14. package/docs/recipes/ci-configurations/README.md +0 -7
  15. package/docs/recipes/ci-configurations/circleci-workflows.md +0 -49
  16. package/docs/recipes/ci-configurations/github-actions.md +0 -136
  17. package/docs/recipes/ci-configurations/gitlab-ci.md +0 -98
  18. package/docs/recipes/ci-configurations/jenkins-ci.md +0 -61
  19. package/docs/recipes/ci-configurations/travis.md +0 -97
  20. package/docs/recipes/git-hosted-services/README.md +0 -3
  21. package/docs/recipes/git-hosted-services/git-auth-ssh-keys.md +0 -166
  22. package/docs/recipes/release-workflow/README.md +0 -5
  23. package/docs/recipes/release-workflow/distribution-channels.md +0 -117
  24. package/docs/recipes/release-workflow/maintenance-releases.md +0 -157
  25. package/docs/recipes/release-workflow/pre-releases.md +0 -197
  26. package/docs/support/FAQ.md +0 -253
  27. package/docs/support/README.md +0 -7
  28. package/docs/support/git-version.md +0 -4
  29. package/docs/support/node-support-policy.md +0 -21
  30. package/docs/support/node-version.md +0 -38
  31. package/docs/support/resources.md +0 -22
  32. package/docs/support/troubleshooting.md +0 -70
  33. package/docs/usage/README.md +0 -9
  34. package/docs/usage/ci-configuration.md +0 -50
  35. package/docs/usage/configuration.md +0 -206
  36. package/docs/usage/getting-started.md +0 -8
  37. package/docs/usage/installation.md +0 -51
  38. package/docs/usage/plugins.md +0 -105
  39. package/docs/usage/shareable-configurations.md +0 -7
  40. package/docs/usage/workflow-configuration.md +0 -199
@@ -1,233 +0,0 @@
1
- # Plugins list
2
-
3
- ## Official plugins
4
-
5
- - [@semantic-release/commit-analyzer](https://github.com/semantic-release/commit-analyzer)
6
- - **Note**: this is already part of semantic-release and does not have to be installed separately
7
- - `analyzeCommits`: Determine the type of release by analyzing commits with [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog)
8
- - [@semantic-release/release-notes-generator](https://github.com/semantic-release/release-notes-generator)
9
- - **Note**: this is already part of semantic-release and does not have to be installed separately
10
- - `generateNotes`: Generate release notes for the commits added since the last release with [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog)
11
- - [@semantic-release/github](https://github.com/semantic-release/github)
12
- - **Note**: this is already part of semantic-release and does not have to be installed separately
13
- - `verifyConditions`: Verify the presence and the validity of the GitHub authentication and release configuration
14
- - `publish`: Publish a [GitHub release](https://help.github.com/articles/about-releases)
15
- - `success`: Add a comment to GitHub issues and pull requests resolved in the release
16
- - `fail`: Open a GitHub issue when a release fails
17
- - [@semantic-release/npm](https://github.com/semantic-release/npm)
18
- - **Note**: this is already part of semantic-release and does not have to be installed separately
19
- - `verifyConditions`: Verify the presence and the validity of the npm authentication and release configuration
20
- - `prepare`: Update the package.json version and create the npm package tarball
21
- - `publish`: Publish the package on the npm registry
22
- - [@semantic-release/gitlab](https://github.com/semantic-release/gitlab)
23
- - `verifyConditions`: Verify the presence and the validity of the GitLab authentication and release configuration
24
- - `publish`: Publish a [GitLab release](https://docs.gitlab.com/ee/user/project/releases/)
25
- - [@semantic-release/git](https://github.com/semantic-release/git)
26
- - `verifyConditions`: Verify the presence and the validity of the Git authentication and release configuration
27
- - `prepare`: Push a release commit and tag, including configurable files
28
- - [@semantic-release/changelog](https://github.com/semantic-release/changelog)
29
- - `verifyConditions`: Verify the presence and the validity of the configuration
30
- - `prepare`: Create or update the changelog file in the local project repository
31
- - [@semantic-release/exec](https://github.com/semantic-release/exec)
32
- - `verifyConditions`: Execute a shell command to verify if the release should happen
33
- - `analyzeCommits`: Execute a shell command to determine the type of release
34
- - `verifyRelease`: Execute a shell command to verifying a release that was determined before and is about to be published
35
- - `generateNotes`: Execute a shell command to generate the release note
36
- - `prepare`: Execute a shell command to prepare the release
37
- - `publish`: Execute a shell command to publish the release
38
- - `success`: Execute a shell command to notify of a new release
39
- - `fail`: Execute a shell command to notify of a failed release
40
- - [@semantic-release/apm](https://github.com/semantic-release/apm)
41
- - `verifyConditions`: Verify the presence of the `ATOM_ACCESS_TOKEN` environment variable and the [`apm`](https://github.com/atom/apm) CLI
42
- - `prepare`: Update the `package.json` version with [`npm version`](https://docs.npmjs.com/cli/version)
43
- - `publish`: Publish the [Atom package](https://flight-manual.atom.io/hacking-atom/sections/publishing)
44
-
45
- ## Community plugins
46
-
47
- [Open a Pull Request](https://github.com/semantic-release/semantic-release/blob/master/CONTRIBUTING.md#submitting-a-pull-request) to add your plugin to the list.
48
-
49
- - [semantic-release-slack-bot](https://github.com/juliuscc/semantic-release-slack-bot)
50
- - `verifyConditions`: Verify that the environment variable `SLACK_WEBHOOK` has been defined.
51
- - `success`: Publish a message about the success to a slack channel.
52
- - `fail`: Optionally publish a message about failure to a slack channel.
53
- - [semantic-release-docker](https://github.com/felixfbecker/semantic-release-docker)
54
- - `verifyConditions`: Verify that all needed configuration is present and login to the Docker registry.
55
- - `publish`: Tag the image specified by `name` with the new version, push it to Docker Hub and update the latest tag
56
- - [@semantic-release-plus/docker](https://github.com/semantic-release-plus/semantic-release-plus/tree/master/packages/plugins/docker)
57
- - `verifyConditions`: Verify that all needed configuration is present and login to the configured docker registry.
58
- - `publish`: Tag the image specified by `name` with the new version and channel and push it to the configured docker registry.
59
- - `addChannel`: Updates a release published on one channel with the destinations channel tag and pushes to the registry i.e.: next to latest.
60
- - [semantic-release-gcr](https://github.com/carlos-cubas/semantic-release-gcr)
61
- - `verifyConditions`: Verify that all needed configuration is present and login to the Docker registry
62
- - `publish`: Tag the image specified by `name` with the new version, push it to Docker Hub and update the latest tag
63
- - [semantic-release-vsce](https://github.com/raix/semantic-release-vsce)
64
- - `verifyConditions`: Verify the presence and the validity of the "VS Code extension" authentication and release configuration
65
- - `prepare`: Create a `.vsix` for distribution
66
- - `publish`: Publish the package to the Visual Studio Code marketplace
67
- - [semantic-release-verify-deps](https://github.com/piercus/semantic-release-verify-deps)
68
- - `verifyConditions`: Check the dependencies format against a regexp before a release
69
- - [semantic-release-openapi](https://github.com/aensley/semantic-release-openapi)
70
- - `verifyConditions`: Verify `apiSpecFiles` is specified with at least one file name and all matching files have a .json, .yaml, or .yml extension.
71
- - `prepare`: Write the correct version to all OpenAPI / Swagger files specified in `apiSpecFiles`.
72
- - [semantic-release-chrome](https://github.com/GabrielDuarteM/semantic-release-chrome)
73
- - `verifyConditions`: Verify the presence of the authentication (set via environment variables)
74
- - `prepare`: Write the correct version to the `manifest.json` and creates a zip file of the whole dist folder
75
- - `publish`: Uploads the generated zip file to the webstore, and publish the item
76
- - [semantic-release-firefox-add-on](https://github.com/tophat/semantic-release-firefox-add-on)
77
- - `verifyConditions`: Verify that all required options are present and authentication is set via environment variables
78
- - `prepare`: Write the correct version to the `manifest.json`
79
- - `publish`: Creates an unsigned `.xpi` file, and submits it to the Mozilla Add On store for signing. Once the package is signed, downloads the signed `.xpi` to a local directory
80
- - [semantic-release-gerrit](https://github.com/pascalMN/semantic-release-gerrit)
81
- - `generateNotes`: Generate release notes with Gerrit reviews URL
82
- - [semantic-release-expo](https://github.com/bycedric/semantic-release-expo)
83
- - `verifyConditions`: Verify Expo manifest(s) are readable and valid.
84
- - `prepare`: Update version, ios build number and android version code in the Expo manifest(s).
85
- - [maven-semantic-release](https://github.com/conveyal/maven-semantic-release)
86
- - `verifyConditions`: Verifies that the `pom.xml` file and other files exist and are setup to allow releases
87
- - `verifyRelease`: Checks and warns (does not error by default) if the version numbers found on maven central and within the Git project differ by quite a bit
88
- - `prepare`: Changes the version number in the `pom.xml` (or all `pom.xml` files in maven projects with multiple `pom.xml` files) and optionally creates a commit with this version number and pushes it to `master`
89
- - `publish`: Runs `mvn deploy` to deploy to maven central and optionally will update to next snapshot version and merge changes to development branch
90
- - [maven-semantic-release](https://github.com/terrestris/maven-semantic-release) (alternative version)
91
- - `verifyConditions`: Verifies that the `mvn` command exists.
92
- - `prepare`: Changes version number in `pom.xml` and optionally in all child modules.
93
- - `publish`: Runs one of the mvn targets `deploy`, `package jib:build` or `deploy jib:build`.
94
- - `success`: Optionally sets new snapshot version and commits it.
95
- - [semantic-release-ado](https://github.com/lluchmk/semantic-release-ado)
96
- - `prepare`: Stores the version number as an Azure DevOps pipeline variable available to downstream steps on the job
97
- - [gradle-semantic-release](https://github.com/KengoTODA/gradle-semantic-release-plugin)
98
- - `verifyConditions`: Verify that project has a Gradle wrapper script, and `build.gradle` contains a task to publish artifacts.
99
- - `prepare`: Changes the version number in the `gradle.properties`
100
- - `publish`: Triggers Gradle to publish artifacts.
101
- - [semantic-release-circleci-orb](https://github.com/matt-oakes/semantic-release-circleci-orb)
102
- - `verifyConditions`: Verify the presence of the `CIRCLECI_API_TOKEN` environment variable, `orbName` option, and the `circleci` CLI.
103
- - `publish`: Publish the CircleCI orb.
104
- - [semantic-release-github-pages](https://github.com/qiwi/semantic-release-gh-pages-plugin)
105
- - `verifyConditions`: Verify the presence of the auth token set via environment variables.
106
- - `publish`: Pushes commit to the documentation branch.
107
- - [semantic-release-github-pullrequest](https://github.com/asbiin/semantic-release-github-pullrequest)
108
- - `verifyConditions`: Verify the presence and the validity of the GitHub authentication and other configuration.
109
- - `publish`: Create a branch to upload all assets and create the pull request on the base branch on GitHub.
110
- - [leiningen-semantic-release](https://github.com/NoxHarmonium/leiningen-semantic-release)
111
- - `verifyConditions`: Checks the project.clj is syntactically valid.
112
- - `prepare`: Update the project.clj version and package the output jar file.
113
- - `publish`: Publish the jar (and generated Maven metadata) to a maven repository (or clojars).
114
- - [@saithodev/semantic-release-gitea](https://github.com/saitho/semantic-release-gitea)
115
- - `verifyConditions`: Verify the presence and the validity of the authentication and the assets option configuration.
116
- - `publish`: Publish a Gitea release, optionally uploading file assets.
117
- - `addChannel`: Update a Gitea release's pre-release field.
118
- - [semantic-release-replace-plugin](https://github.com/jpoehnelt/semantic-release-replace-plugin)
119
- - `prepare`: Replace version strings in files using regex and glob.
120
- - [semantic-release-rubygem](https://github.com/Gusto/semantic-release-rubygem)
121
- - `verifyConditions`: Locate and validate a `.gemspec` file, locate and validate a `lib/**/version.rb` file, verify the presence of the `GEM_HOST_API_KEY` environment variable, and create a credentials file with the API key.
122
- - `prepare`: Update the version in the `lib/**/version.rb` version file and [build](https://guides.rubygems.org/command-reference/#gem-build) the gem.
123
- - `publish`: [Push the Ruby gem](https://guides.rubygems.org/command-reference/#gem-push) to the gem server.
124
- - [semantic-release-npm-deprecate-old-versions](https://github.com/ghusse/semantic-release-npm-deprecate-old-versions)
125
- - `verifyConditions`: Validates configuration.
126
- - `publish`: Deprecates old versions, based on the declaration of supported versions in the config.
127
- - [amanda-mitchell/semantic-release-npm-multiple](https://github.com/amanda-mitchell/semantic-release-npm-multiple)
128
- - **Note**: this is a thin wrapper around the built-in npm plugin that can target multiple registries
129
- - `verifyConditions`: Verify the presence and the validity of the npm authentication and release configuration for multiple registries
130
- - `prepare`: Update the package.json version and create the npm package tarball
131
- - `publish`: Publish the package on the npm registry for multiple registries
132
- - [semantic-release-license](https://github.com/cbhq/semantic-release-license) Automatically update dates and more in your license file for new releases.
133
- - `verifyConditions`: Verify the presence of a license file
134
- - `prepare`: Update the license file based on its type
135
- - [semantic-release-pypi](https://github.com/abichinger/semantic-release-pypi)
136
- - `verifyConditions`: Verify the environment variable `PYPI_TOKEN` and installation of build tools
137
- - `prepare`: Update the version in `setup.cfg` and create the distribution packages
138
- - `publish`: Publish the python package to a repository (default: pypi)
139
- - [@covage/semantic-release-poetry-plugin](https://github.com/covage/semantic-release-poetry-plugin)
140
- - `verifyConditions`: Verify the presence and validity of `pyproject.toml` file.
141
- - `prepare`: Update the version in `pyproject.toml`.
142
- - [semantic-release-codeartifact](https://github.com/ryansonshine/semantic-release-codeartifact)
143
- - `verifyConditions`: Validate configuration, get AWS CodeArtifact authentication and repository, validate `publishConfig` or `.npmrc` (if they exist), then pass the configuration to the associated plugins.
144
- - [semantic-release-telegram](https://github.com/pustovitDmytro/semantic-release-telegram)
145
- - `verifyConditions`: Validate configuration and verify `TELEGRAM_BOT_ID` and `TELEGRAM_BOT_TOKEN`
146
- - `success`: Publish a message about the successful release to a telegram chat
147
- - `fail`: publish a message about failure to a telegram chat
148
- - [semantic-release-heroku](https://github.com/pustovitDmytro/semantic-release-heroku)
149
- - `verifyConditions`: Validate configuration and verify `HEROKU_API_KEY`
150
- - `prepare`: Update the package.json version and create release tarball
151
- - `publish`: Publish version to heroku
152
- - [semantic-release-mattermost](https://github.com/ttrobisch/semantic-release-mattermost)
153
- - `verifyConditions`: Verify that the webhook is setup and release-notes-generator is present.
154
- - `success`: Send a message about the new release and its notes to a [mattermost](https://mattermost.com/) webhook.
155
- - [semantic-release-github-milestones](https://github.com/nitzano/semantic-release-github-milestones)
156
- - `verifyConditions`: Verify github tokens are present and valid.
157
- - `verifyRelease`: Display information regarding the matching github milestone.
158
- - [semantic-release-telegram-bot](https://github.com/skoropadas/semantic-release-telegram-bot)
159
- - `verifyConditions`: Validate configuration and verify `TELEGRAM_BOT_TOKEN` and package name
160
- - `success`: Publish a success message to certain telegram chats
161
- - `fail`: Publish a fail message to certain telegram chats
162
- - [semantic-release-npm-deprecate](https://github.com/jpoehnelt/semantic-release-npm-deprecate)
163
- - `publish`: Automatically mark old versions as deprecated.
164
- - [semantic-release-mirror-version](https://github.com/GarthDB/semantic-release-mirror-version)
165
- - `prepare`: Update the version number in any file that matches the defined [file glob](https://github.com/isaacs/node-glob).
166
- - [semantic-release-space](https://github.com/123FLO321/semantic-release-space)
167
- - `verifyConditions` Verifies that all required options are set.
168
- - `prepare` Creates a JetBrains Space Deployment Target if it does not yet exist.
169
- - `publish` Starts a JetBrains Space Deployment.
170
- - `success` Marks the JetBrains Space Deployment as completed.
171
- - `fail` Marks the JetBrains Space Deployment as failed.
172
- - [semantic-release-react-native](https://github.com/alexandermendes/semantic-release-react-native)
173
- - `verifyConditions` Validate configuration.
174
- - `prepare` Version native iOS and Android files.
175
- - [semantic-release-cargo](https://github.com/buehler/semantic-release-cargo)
176
- - `verifyConditions` Validate configuration, `Cargo.toml`, and local cargo executable. Also, logs in into `crates.io`.
177
- - `prepare` Write the new version number into `Cargo.toml` file and perform `cargo check` if configured.
178
- - `publish` Publish the Rust crate to `crates.io`
179
- - [semantic-release-coralogix](https://github.com/adobe/semantic-release-coralogix)
180
- - `verifyConditions` Verified that required credentials are provided and API is accessible
181
- - `publish` add a release tag to Coralogix
182
- - [semantic-release-jira-notes](https://github.com/iamludal/semantic-release-jira-notes)
183
- - `verifyConditions`: Validate the config options.
184
- - `generateNotes`: Generate the release notes with links to JIRA issues.
185
- - [semantic-release-major-tag](https://github.com/doteric/semantic-release-major-tag)
186
- - `success` Create major version tag, for example `v1`.
187
- - [semantic-release-yarn](https://github.com/hongaar/semantic-release-yarn)
188
- - **Note**: this is an alternative to the default `@semantic-release/npm` plugin and adds support for monorepos.
189
- - `verifyConditions` Verify Yarn 2 or higher is installed, verify the presence of a NPM auth token (either in an environment variable or a `.yarnrc.yml` file) and verify the authentication method is valid.
190
- - `prepare` Update the `package.json` version and create the package tarball.
191
- - `addChannel` Add a tag for the release.
192
- - `publish` Publish to the npm registry.
193
- - [semantic-release-pub](https://github.com/zeshuaro/semantic-release-pub)
194
- - `verifyConditions`: Verify the presence of the `pub.dev` authentication and release configuration
195
- - `prepare`: Update the `pubspec.yaml` version
196
- - `publish`: Publish the package onto the `pub.dev` registry
197
- - [semantic-release-hackage](https://github.com/stackbuilders/semantic-release-hackage)
198
- - `verifyConditions`: Verify the environment variable `HACKAGE_TOKEN`
199
- - `prepare`: Update the version of .cabal file and create the distribution package (.tar)
200
- - `publish`: Publish the release candidate to the specified repository in Hackage
201
- - [semantic-release-pull-request-analyzer](https://github.com/bobvanderlinden/semantic-release-pull-request-analyzer)
202
- - `verifyConditions` Verify configuration options and existance of GitHub token.
203
- - `analyzeCommits` Determine the type of release by analyzing merged GitHub pull requests and their labels.
204
- - `generateNotes` Generates release notes using [GitHub release notes generator](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes).
205
- - [semantic-release-commits-lint](https://github.com/BondarenkoAlex/semantic-release-commits-lint)
206
- - `analyzeCommits` Analyzing commit messages by [commitlint](https://github.com/conventional-changelog/commitlint).
207
- - [semantic-release-kaniko](https://github.com/brendangeck/semantic-release-kaniko)
208
- - `verifyConditions`: Verify that all needed configuration is present and login to the Docker registry.
209
- - `publish`: Build a container image using [Kaniko](https://github.com/GoogleContainerTools/kaniko) and (optionally) push it to a Docker registry.
210
- - [semantic-release-skopeo](https://github.com/LukasWestholt/semantic-release-skopeo)
211
- - `verifyConditions`: Verify that all needed configuration is present and check if destination is writeable (unless force=true).
212
- - `publish`: Copy OCI images to a custom (Docker) registry using daemonless open-source tool [skopeo](https://github.com/containers/skopeo/).
213
- - [sr-uv-plugin](https://github.com/Artessan-Devs/sr-uv-plugin)
214
- - `verifyConditions`: Ensures `pyproject.toml` exists and contains a `[project]` section.
215
- - `prepare`: Updates the `[project].version` field in `pyproject.toml` to match the release version.
216
- - [semantic-release-uv](https://github.com/Deltamir/semantic-release-uv)
217
- - `verifyConditions`: Verify the presence and validity of a `PYPI_TOKEN` and validate the `pyproject.toml` structure
218
- - `prepare`: Update the version in `pyproject.toml`, locking and build the distribution with `uv`
219
- - `publish`: Publish the package to PyPI or a custom index using `uv publish`
220
- - [@jno21/semantic-release-github-commit](https://github.com/Jno21/semantic-release-github-commit)
221
- - **Notes**: This plugin creates a commit on GitHub using the GitHub API, enabling signed commits via a GitHub App.
222
- - `verifyConditions`: Verify GitHub authentication and configuration.
223
- - `prepare`: Create a commit with the specified files using the GitHub API.
224
- - [semantic-release-minecraft](https://github.com/pynickle/semantic-release)
225
- - `verifyConditions`: Verify that all needed configuration is present.
226
- - `prepare`: Convert different types of CurseForge game versions to their corresponding IDs.
227
- - `publish`: Publish the Minecraft project to CurseForge and Modrinth.
228
- - [semantic-release-jira-fixversion](https://github.com/danbka33/semantic-release-jira-fixversion)
229
- - `verifyConditions`: Verify Jira Server/Data Center connectivity, authentication, and plugin configuration.
230
- - `success`: Create or reuse Jira Versions for affected projects, update `fixVersions`, add release comments to referenced issues, and transition them to the configured workflow state.
231
- - [semantic-release-linear-issue-status](https://github.com/noahlaux/semantic-release-linear-issue-status)
232
- - `verifyConditions`: Verify the presence of the `LINEAR_API_KEY` environment variable and required configuration options (`teamKey`, `issuePrefixes`).
233
- - `success`: Move linked [Linear](https://linear.app) issues to a completed workflow state after a successful release, based on issue identifiers found in release commits.
@@ -1,22 +0,0 @@
1
- # Shareable configurations list
2
-
3
- ## Official configurations
4
-
5
- - [@semantic-release/apm-config](https://github.com/semantic-release/apm-config) - semantic-release shareable configuration for releasing atom packages
6
- - [@semantic-release/gitlab-config](https://github.com/semantic-release/gitlab-config) - semantic-release shareable configuration for GitLab
7
-
8
- ## Community configurations
9
-
10
- - [@jedmao/semantic-release-npm-github-config](https://github.com/jedmao/semantic-release-npm-github-config)
11
- - Provides an informative [Git](https://github.com/semantic-release/git) commit message for the release commit that does not trigger continuous integration and conforms to the [conventional commits specification](https://www.conventionalcommits.org/) (e.g., `chore(release): 1.2.3 [skip ci]\n\nnotes`).
12
- - Creates a tarball that gets uploaded with each [GitHub release](https://github.com/semantic-release/github).
13
- - Publishes the same tarball to [npm](https://github.com/semantic-release/npm).
14
- - Commits the version change in `package.json`.
15
- - Creates or updates a [changelog](https://github.com/semantic-release/changelog) file.
16
- - [semantic-release-npm-github-publish](https://github.com/oleg-koval/semantic-release-npm-github-publish)
17
- - Based on [angular preset](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).
18
- - Adds more keywords for the `chore` **PATCH** release.
19
- - Generates or updates a [changelog](https://github.com/semantic-release/changelog) file including all **PATCH** keywords (not included in default angular package).
20
- - Updates GitHub release with release-notes.
21
- - Bumps a version in package.json.
22
- - Publishes the new version to [NPM](https://npmjs.org).
@@ -1,7 +0,0 @@
1
- # CI configurations
2
-
3
- - [CircleCI 2.0 workflows](circleci-workflows.md)
4
- - [Travis CI](travis.md)
5
- - [GitLab CI](gitlab-ci.md)
6
- - [GitHub Actions](github-actions.md)
7
- - [Jenkins CI](jenkins-ci.md)
@@ -1,49 +0,0 @@
1
- # Using semantic-release with [CircleCI 2.0 workflows](https://circleci.com/docs/2.0/workflows)
2
-
3
- ## Environment variables
4
-
5
- The [Authentication](../../usage/ci-configuration.md#authentication) environment variables can be configured in [CircleCi Project Settings](https://circleci.com/docs/2.0/env-vars/#adding-environment-variables-in-the-app)..
6
-
7
- Alternatively, the default `NPM_TOKEN` and `GH_TOKEN` can be easily [setup with semantic-release-cli](../../usage/getting-started.md#getting-started).
8
-
9
- ## Multiple Node jobs configuration
10
-
11
- ### `.circleci/config.yml` configuration for multiple Node jobs
12
-
13
- This example is a minimal configuration for **semantic-release** with tests running against Node 16 and 14.
14
- See [CircleCI documentation](https://circleci.com/docs/2.0) for additional configuration options.
15
-
16
- In this example, the [`circleci/node`](https://circleci.com/developer/orbs/orb/circleci/node) orb is imported (Which makes some node operations easier), then a `release` job is defined which will run `semantic-release`.
17
-
18
- To run our `release` job, we have created a workflow named `test_and_release` which will run two jobs, `node/test`, which comes from the node orb and will test our application, and our release job.
19
- Here, we are actually making use of [matrix jobs](https://circleci.com/blog/circleci-matrix-jobs/) so that our single `node/test` job will actually be executed twice, once for Node version 16, and once for version 14.
20
- Finally, we call our release job with a `requires` parameter so that `release` will run against the latest LTS version of node, only after `node/test` has successfully tested against v14 and v16.
21
-
22
- ```yaml
23
- version: 2.1
24
- orbs:
25
- node: circleci/node@5.0.0
26
- jobs:
27
- release:
28
- executor: node/default
29
- steps:
30
- - checkout
31
- - node/install-packages # Install and automatically cache packages
32
- # Run optional required steps before releasing
33
- # - run: npm run build-script
34
- - run: npx semantic-release
35
-
36
- workflows:
37
- test_and_release:
38
- # Run the test jobs first, then the release only when all the test jobs are successful
39
- jobs:
40
- - node/test:
41
- matrix:
42
- parameters:
43
- version:
44
- - 16.1.0
45
- - 14.17.0
46
- - release:
47
- requires:
48
- - node/test
49
- ```
@@ -1,136 +0,0 @@
1
- # Using semantic-release with [GitHub Actions](https://help.github.com/en/categories/automating-your-workflow-with-github-actions)
2
-
3
- ## Environment variables
4
-
5
- The [Authentication](../../usage/ci-configuration.md#authentication) environment variables can be configured with [Secret Variables](https://docs.github.com/en/actions/reference/encrypted-secrets).
6
-
7
- In this example a publish type [`NPM_TOKEN`](https://docs.npmjs.com/creating-and-viewing-authentication-tokens) is required to publish a package to the npm registry. GitHub Actions [automatically populate](https://docs.github.com/en/actions/security-guides/automatic-token-authentication) a [`GITHUB_TOKEN`](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) environment variable which can be used in Workflows.
8
-
9
- ## Trusted publishing and npm provenance
10
-
11
- For improved security and automation, it is recommended to leverage [trusted publishing](https://docs.npmjs.com/trusted-publishers) through [OpenID Connect (OIDC)](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect) when publishing to npm from GitHub Actions.
12
- GitHub Actions is a [trusted identity provider](https://docs.npmjs.com/trusted-publishers#identity-providers) for npm, enabling configuration of a trust relationship between your GitHub repository and npm so that no long-lived secret (like an `NPM_TOKEN`) is required to publish packages to npm from GitHub Actions.
13
- The npm registry [recently increased restrictions for use of long-lived access tokens](https://github.blog/changelog/2025-09-29-strengthening-npm-security-important-changes-to-authentication-and-token-management/), further encouraging trusted publishing as the preferred approach for publishing to npm from GitHub Actions.
14
- Enabling trusted publishing requires granting the `id-token: write` permission to the job performing the publish step and [configuring a trust relationship](https://docs.npmjs.com/trusted-publishers#step-1-add-a-trusted-publisher-on-npmjscom) between your GitHub repository and npm.
15
-
16
- **Note**: When setting up a Trusted Publisher on npmjs for GitHub Actions, it's crucial to specify the workflow file that triggers the release process, not necessarily the one that contains the release logic itself.
17
- If your release job is encapsulated in a [reusable workflow](https://docs.github.com/en/actions/how-tos/reuse-automations/reuse-workflows), the workflow file you must reference is the caller workflow—typically the one triggered by events like `push` or `workflow_dispatch` on your main branch.
18
- This is because npm's Trusted Publisher mechanism authorizes the workflow that initiates the run, not any downstream workflows it invokes.
19
-
20
- [npm provenance](https://docs.npmjs.com/generating-provenance-statements) is valuable for increasing supply-chain security for your npm packages.
21
- Before trusted publishing was available, generating provenance attestations required configuring your project to enable publishing with provenance.
22
- With trusted publishing, npm provenance is automatically generated for packages published to npm from GitHub Actions without any additional configuration.
23
-
24
- ## Important: Avoid `registry-url` in `setup-node`
25
-
26
- **Do not** set the `registry-url` option in the `actions/setup-node` step when using semantic-release for npm publishing. The `registry-url` option causes `setup-node` to create an `.npmrc` file that can conflict with semantic-release's npm authentication mechanism, leading to `EINVALIDNPMTOKEN` errors even when your token is valid.
27
-
28
- ```yaml
29
- # ❌ Don't do this - can cause conflicts with semantic-release
30
- - name: Setup Node.js
31
- uses: actions/setup-node@v4
32
- with:
33
- node-version: "lts/*"
34
- registry-url: "https://registry.npmjs.org"
35
-
36
- # ✅ Do this instead - let semantic-release handle npm authentication
37
- - name: Setup Node.js
38
- uses: actions/setup-node@v4
39
- with:
40
- node-version: "lts/*"
41
- ```
42
-
43
- If you need to specify a custom registry, configure it in your project's `.npmrc` file instead. This ensures consistent behavior between local development and CI environments, and avoids conflicts with semantic-release.
44
-
45
- ## Node project configuration
46
-
47
- [GitHub Actions](https://github.com/features/actions) support [Workflows](https://help.github.com/en/articles/configuring-workflows), allowing to run tests on multiple Node versions and publish a release only when all test pass.
48
-
49
- **Note**: The publish pipeline must run on a [Node version that meets our version requirement](../../support/node-version.md).
50
-
51
- ### `.github/workflows/release.yml` configuration for Node projects
52
-
53
- The following is a minimal configuration for [`semantic-release`](https://github.com/semantic-release/semantic-release) with a build running on the latest LTS version of Node when a new commit is pushed to a `master/main` branch.
54
- See the [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions) for additional configuration options.
55
-
56
- ```yaml
57
- name: Release
58
- on:
59
- push:
60
- branches:
61
- - master # or main
62
-
63
- permissions:
64
- contents: read # for checkout
65
-
66
- jobs:
67
- release:
68
- name: Release
69
- runs-on: ubuntu-latest
70
- permissions:
71
- contents: write # to be able to publish a GitHub release
72
- issues: write # to be able to comment on released issues
73
- pull-requests: write # to be able to comment on released pull requests
74
- id-token: write # to enable use of OIDC for trusted publishing and npm provenance
75
- steps:
76
- - name: Checkout
77
- uses: actions/checkout@v4
78
- with:
79
- fetch-depth: 0
80
- - name: Setup Node.js
81
- uses: actions/setup-node@v4
82
- with:
83
- node-version: "lts/*"
84
- - name: Install dependencies
85
- run: npm clean-install
86
- - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
87
- run: npm audit signatures
88
- - name: Release
89
- env:
90
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
91
- run: npx semantic-release
92
- ```
93
-
94
- ## Pushing `package.json` changes to your repository
95
-
96
- If you choose to commit changes to your `package.json` [against our recommendation](../../support/FAQ.md#making-commits-during-the-release-process-adds-significant-complexity), the [`@semantic-release/git`](https://github.com/semantic-release/git) plugin can be used.
97
-
98
- **Note**: Automatically populated `GITHUB_TOKEN` cannot be used if branch protection is enabled for the target branch.
99
- It is **not** advised to mitigate this limitation by overriding an automatically populated `GITHUB_TOKEN` variable with a [Personal Access Tokens](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line), as it poses a security risk.
100
- Since Secret Variables are available for Workflows triggered by any branch, it becomes a potential vector of attack, where a Workflow triggered from a non-protected branch can expose and use a token with elevated permissions, yielding branch protection insignificant.
101
- One can use Personal Access Tokens in trusted environments, where all developers should have the ability to perform administrative actions in the given repository and branch protection is enabled solely for convenience purposes, to remind about required reviews or CI checks.
102
-
103
- If the risk is acceptable, some extra configuration is needed. The [actions/checkout `persist-credentials`](https://github.com/marketplace/actions/checkout#usage) option needs to be `false`, otherwise the generated `GITHUB_TOKEN` will interfere with the custom one. Example:
104
-
105
- ```yaml
106
- - name: Checkout
107
- uses: actions/checkout@v2
108
- with:
109
- fetch-depth: 0
110
- persist-credentials: false # <--- this
111
- ```
112
-
113
- ## Trigger semantic-release on demand
114
-
115
- ### Using GUI:
116
-
117
- You can use [Manual Triggers](https://github.blog/changelog/2020-07-06-github-actions-manual-triggers-with-workflow_dispatch/) for GitHub Actions.
118
-
119
- ### Using HTTP:
120
-
121
- Use [`repository_dispatch`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#repository_dispatch) event to have control on when to generate a release by making an HTTP request, e.g.:
122
-
123
- ```yaml
124
- name: Release
125
- on:
126
- repository_dispatch:
127
- types: [semantic-release]
128
- jobs:
129
- # ...
130
- ```
131
-
132
- To trigger a release, call (with a [Personal Access Tokens](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) stored in `GITHUB_TOKEN` environment variable):
133
-
134
- ```
135
- $ curl -v -H "Accept: application/vnd.github.everest-preview+json" -H "Authorization: token ${GITHUB_TOKEN}" https://api.github.com/repos/[org-name-or-username]/[repository]/dispatches -d '{ "event_type": "semantic-release" }'
136
- ```
@@ -1,98 +0,0 @@
1
- # Using semantic-release with [GitLab CI](https://about.gitlab.com/features/gitlab-ci-cd)
2
-
3
- ## Environment variables
4
-
5
- The [Authentication](../../usage/ci-configuration.md#authentication) environment variables can be configured with [Protected variables](https://docs.gitlab.com/ce/ci/variables/README.html#protected-environment-variables).
6
-
7
- **Note**: Make sure to configure your release branch as [protected](https://docs.gitlab.com/ce/user/project/protected_branches.html) in order for the CI/CD build to access the protected variables.
8
-
9
- ## npm provenance
10
-
11
- Since GitLab CI is a [supported provider](https://docs.npmjs.com/generating-provenance-statements#provenance-limitations) for [npm provenance](https://docs.npmjs.com/generating-provenance-statements), it is recommended to enable this to increase supply-chain security for your npm packages.
12
- Find more detail about configuring npm to publish with provenance through semantic-release [in the documentation for our npm plugin](https://github.com/semantic-release/npm#npm-provenance).
13
-
14
- ## Node project configuration
15
-
16
- GitLab CI supports [Pipelines](https://docs.gitlab.com/ee/ci/pipelines.html) allowing to test on multiple Node versions and publishing a release only when all test pass.
17
-
18
- **Note**: The publish pipeline must run a [Node version that meets our version requirement](../../support/node-version.md).
19
-
20
- ### `.gitlab-ci.yml` configuration for Node projects
21
-
22
- This example is a minimal configuration for **semantic-release** with a build running Node 10 and 12. See [GitLab CI - Configuration of your jobs with `.gitlab-ci.yml`](https://docs.gitlab.com/ee/ci/yaml/README.html) for additional configuration options.
23
-
24
- **Note**: The`semantic-release` execution command varies depending on whether you are using a [local](../../usage/installation.md#local-installation) or [global](../../usage/installation.md#global-installation) **semantic-release** installation.
25
-
26
- ```yaml
27
- # The release pipeline will run only if all jobs in the test pipeline are successful
28
- stages:
29
- - test
30
- - release
31
-
32
- before_script:
33
- - npm install
34
-
35
- node:10:
36
- image: node:10
37
- stage: test
38
- script:
39
- - npm test
40
-
41
- node:12:
42
- image: node:12
43
- stage: test
44
- script:
45
- - npm test
46
-
47
- publish:
48
- image: node:12
49
- stage: release
50
- script:
51
- - npx semantic-release
52
- ```
53
-
54
- ### `.gitlab-ci.yml` configuration for all projects
55
-
56
- This example is a minimal configuration for **semantic-release** with a build running Node 10 and 12. See [GitLab CI - Configuration of your jobs with `.gitlab-ci.yml`](https://docs.gitlab.com/ee/ci/yaml/README.html) for additional configuration options.
57
-
58
- **Note**: The`semantic-release` execution command varies depending if you are using a [local](../../usage/installation.md#local-installation) or [global](../../usage/installation.md#global-installation) **semantic-release** installation.
59
-
60
- ```yaml
61
- # The release pipeline will run only on the master/main branch a commit is triggered
62
- stages:
63
- - release
64
-
65
- release:
66
- image: node:10-buster-slim
67
- stage: release
68
- before_script:
69
- - apt-get update && apt-get install -y --no-install-recommends git-core ca-certificates
70
- - npm install -g semantic-release @semantic-release/gitlab
71
- script:
72
- - semantic-release
73
- rules:
74
- - if: $CI_COMMIT_BRANCH == "master" # or main
75
-
76
- release:
77
- image: node:12-buster-slim
78
- stage: release
79
- before_script:
80
- - apt-get update && apt-get install -y --no-install-recommends git-core ca-certificates
81
- - npm install -g semantic-release @semantic-release/gitlab
82
- script:
83
- - semantic-release
84
- rules:
85
- - if: $CI_COMMIT_BRANCH == "master" # or main
86
- ```
87
-
88
- ### `package.json` configuration
89
-
90
- A `package.json` is required only for [local](../../usage/installation.md#local-installation) **semantic-release** installation.
91
-
92
- ```json
93
- {
94
- "devDependencies": {
95
- "semantic-release": "^15.0.0"
96
- }
97
- }
98
- ```
@@ -1,61 +0,0 @@
1
- # Using semantic-release with [Jenkins CI](https://www.jenkins.io/doc/book/pipeline/)
2
-
3
- ## Environment variables
4
-
5
- The [Authentication](../../usage/ci-configuration.md#authentication) environment variables can be configured in [Jenkins Project Settings](https://www.jenkins.io/doc/pipeline/tour/environment/)..
6
-
7
- Alternatively, the default `NPM_TOKEN` and `GH_TOKEN` can be easily [setup with semantic-release-cli](../../usage/getting-started.md#getting-started).
8
-
9
- ## Node.js project configuration
10
-
11
- ### `Jenkinsfile (Declarative Pipeline)` configuration for a Node.js job
12
-
13
- **Note**: The publish pipeline must run a Node version that [meets our requirement](../../support/node-version.md).
14
-
15
- This example is a minimal configuration for **semantic-release** with a build running a version of Node labelled as "node LTS".
16
- Since versions of Node are manually downloaded and labelled, we recommend keeping the version used for the release steps up-to-date with the latest LTS version.
17
- See the [Jenkins documentation](https://www.jenkins.io/doc/) for additional configuration options.
18
-
19
- ```yaml
20
- // The release stage in the pipeline will run only if the test stage in the pipeline is successful
21
- pipeline {
22
- agent any
23
- environment {
24
- GH_TOKEN = credentials('some-id')
25
- }
26
- stages {
27
- stage('Test') {
28
- steps {
29
- sh '''
30
- # Configure your test steps here (checkout, npm install, tests etc)
31
- npm install
32
- npm test
33
- '''
34
- }
35
- }
36
- stage('Release') {
37
- tools {
38
- nodejs "node LTS"
39
- }
40
- steps {
41
- sh '''
42
- # Run optional required steps before releasing
43
- npx semantic-release
44
- '''
45
- }
46
- }
47
- }
48
- }
49
- ```
50
-
51
- ### `package.json` configuration for a Node job
52
-
53
- A `package.json` is required only for [local](../../usage/installation.md#local-installation) **semantic-release** installation.
54
-
55
- ```json
56
- {
57
- "devDependencies": {
58
- "semantic-release": "^18.0.0"
59
- }
60
- }
61
- ```