This packages defines the strict implementation of the HDNET Semantic Release Workflow from the HDNET Standard Recommendations (HSR-20) as npm package using semantic-release through a shareable config.
-
Make sure you use Node.js >= 20.
-
Install dependencies
$ npm i -D semantic-release @hdnet/semantic-release-config
- Create a semantic-release config (i.e.
release.config.mjs
) and extend from @hdnet/semantic-release-config:
export default {
extends: '@hdnet/semantic-release-config',
}
- Add semantic-release to your CI workflow.
- supports composer through
@iwavesmedia/semantic-release-composer
plugin - allows overwriting
issueUrlFormat
through the env ISSUE_URL_FORMAT - allows setting
issuePrefixes
(default:#
) through the env ISSUE_PREFIX
To setup current node version, you can use nvm (in this project a .nvmrc file is maintained).