diff --git a/configs/release-config/README.md b/configs/release-config/README.md new file mode 100644 index 0000000..582e483 --- /dev/null +++ b/configs/release-config/README.md @@ -0,0 +1,26 @@ +# @gewis/release-config + +Sharable semantic-release configuration for GEWIS projects. + +## Installation + +```bash +npm install @gewis/release-config --save-dev +yarn add @gewis/release-config --dev +``` + +## Configuration + +In your semantic-release configuration file, add the following: + +```javascript +import { releaseConfig } from '@gewis/release-config'; + +/** + * @type {import('semantic-release').GlobalConfig} + */ +export default { + branches: ["main"], + ...releaseConfig +}; +``` diff --git a/configs/release-config/index.mjs b/configs/release-config/index.mjs new file mode 100644 index 0000000..8ed246e --- /dev/null +++ b/configs/release-config/index.mjs @@ -0,0 +1,18 @@ +const releaseConfig = { + "plugins": [ + "@semantic-release/commit-analyzer", + "@semantic-release/release-notes-generator", + [ + "@semantic-release/github", + { + "successComment": false, + "failComment": false, + "failTitle": false, + "labels": false, + "releasedLabels": false + } + ] + ] +}; + +export {releaseConfig}; diff --git a/configs/release-config/package.json b/configs/release-config/package.json new file mode 100644 index 0000000..0b82f91 --- /dev/null +++ b/configs/release-config/package.json @@ -0,0 +1,24 @@ +{ + "name": "@gewis/release-config", + "version": "3.0.0", + "description": "Release configuration for GEWIS projects", + "homepage": "https://github.com/GEWIS/js-configs#readme", + "bugs": { + "url": "https://github.com/GEWIS/js-configs/issues" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/GEWIS/js-configs.git", + "directory": "configs/release-config" + }, + "publishConfig": { + "access": "public", + "registry": "https://npm.pkg.github.com" + }, + "license": "AGPL-3.0-or-later", + "author": "GEWIS", + "exports": { + ".": "./index.mjs" + }, + "packageManager": "yarn@4.5.1" +}