{"_id":"@droplt/semantic-release-config","_rev":"33-8746236fa06bc48126831f85f1c52990","time":{"2.0.0":"2020-10-26T19:55:53.203Z","created":"2020-10-26T19:56:40.492Z","1.1.0":"2020-10-26T19:56:41.024Z","modified":"2022-04-05T05:42:09.357Z"},"name":"@droplt/semantic-release-config","dist-tags":{"latest":"1.1.0"},"versions":{"1.1.0":{"name":"@droplt/semantic-release-config","version":"1.1.0","description":"@droplt semantic-release shareable configuration","homepage":"https://github.com/droplt/packages#readme","bugs":{"url":"https://github.com/droplt/packages/issues"},"repository":{"type":"git","url":"git+https://github.com/droplt/packages.git"},"license":"MIT","author":{"name":"François Lefebvre","email":"francois.lfe@gmail.com"},"main":"lib/semantic-release-config.js","directories":{"lib":"lib"},"dependencies":{"@semantic-release/changelog":"^5.0.1","@semantic-release/commit-analyzer":"^8.0.1","@semantic-release/exec":"^5.0.0","@semantic-release/github":"^7.1.1","@semantic-release/npm":"^7.0.6","@semantic-release/release-notes-generator":"^9.0.1","conventional-changelog-conventionalcommits":"^4.4.0"},"devDependencies":{"semantic-release":"^17.2.1"},"peerDependencies":{"semantic-release":">=16.0.0 <18.0.0"},"publishConfig":{"access":"public"},"gitHead":"0c080b8c213a72cb0b19db430756b097ce643ba5","_id":"@droplt/semantic-release-config@1.1.0","_nodeVersion":"12.18.0","_npmVersion":"lerna/3.22.1/node@v12.18.0+x64 (darwin)","dist":{"integrity":"sha512-Hx3MOLWTPqRUOvY0iHnJ3oJ6L4k49xrwV7aq3i5ibXd/iQSV6Ut2aYZMuZMwGc3hVjY4BMvqCO4hAemKw2m05w==","shasum":"8dab559295797337897dcb98c4434e0057d0f4a4","tarball":"https://registry.npmjs.org/@droplt/semantic-release-config/-/semantic-release-config-1.1.0.tgz","fileCount":4,"unpackedSize":10099,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJflyn5CRA9TVsSAnZWagAAmyEP/17gDNvK2k0PipbMp9d4\nkh+Kuc86IqzX7ZmEAhBxE8L8R51TnylbhxIp2w80ZiBYF23oDzkraVbfOkQP\nQ819Q1iEWrcb/H3eP3Vw/Qe2smSlYOoK9ZBk16VaG4b0gFo9UucV4t/uZboP\n+vxJe3eo689fIiZwp9CbpcUt2ajkkRBv4AmMPSfwMKZn5lYchQFXIpWzPKqX\njUhOmprM7kUcLQuefLaa738I/TUW2aDTs12ZqdTBk+cHluPOsu/VQ7RXtJ8u\nWDbl9U7A+AqAZRQ/EbtMnvbNP8fizcIwrFQce6CIaHoE/VXypPcyTAweCwkJ\nth0GYf4txK9Br15ThNebEVzHzIf3qs8Ih79XP+GZKLW5AMvXco2rLKLNl9IG\nOt9y2HFtShDFJmzyBpTpshjCHa7qLdrpkRlAX8p4EC02+PEm6yThXBHgDF/D\nmSLBLJK0/0Gj2avA3B/cKJ+NIYylugclnjUnGTEjGTz3B8RESuSPcqjCRWSW\nGmlkTQGUsvcJPnW0NxhC9EWd9WJrG5nBKhwaRlNc3s50fxHewgVXzgVEV2Aj\ntWSneqD/NI4PTwOauyfeAxLM6dGYHOChXwSH9eX4mXyRJvaxPSE0mCN5EySo\nf7ukJrMHHQi70Q7P2Fu/tL6MSpXhaZd3CA8Kmbx6OinN5igPvb2imfenmkwx\nMJsg\r\n=CH6v\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDiwzw6xL5y2o1+mjGUWAAyN4MH1iaI27QfP3Rj3KMM9QIhALfQaRbqZXzC38NWkd7zfK9BHCacWICE/LH8hFeBb7X9"}]},"maintainers":[{"name":"francoislef","email":"francois.lfe@gmail.com"}],"_npmUser":{"name":"francoislef","email":"francois.lfe@gmail.com"},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/semantic-release-config_1.1.0_1603742200863_0.09791589856103067"},"_hasShrinkwrap":false}},"maintainers":[{"name":"francoislef","email":"francois.lfe@gmail.com"}],"description":"@droplt semantic-release shareable configuration","homepage":"https://github.com/droplt/packages#readme","repository":{"type":"git","url":"git+https://github.com/droplt/packages.git"},"author":{"name":"François Lefebvre","email":"francois.lfe@gmail.com"},"bugs":{"url":"https://github.com/droplt/packages/issues"},"license":"MIT","readme":"@droplt/semantic-release-config
\n\n[**Semantic-release**](https://github.com/semantic-release/semantic-release) shareable config for droplt.\n\n- [Workflow](#workflow)\n- [Plugins](#plugins)\n- [Install](#install)\n- [Usage](#usage)\n- [Examples](#examples)\n - [Run NPM script before release](#run-npm-script-before-release)\n\n## Workflow\n\nThis shareable configuration use the [`conventional-changelog-conventionalcommits`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-conventionalcommits) preset ([conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)).\n\nSee the list of commits **types** and their impact on **version bump**, **changelog** generation and **release trigger**.\n\n| Commit Type | Trigger release | Version Bump | Changelog Section | Changelog Visibility |\n| ----------- | :----------------: | :--------------------: | ---------------------------- | :------------------: |\n| `build` | ✅ | patch (_v0.0._**1**) | **Build System** | ❌ |\n| `ci` | ✅ | patch (_v0.0._**1**) | **Continuous Integration** | ❌ |\n| `chore` | ❌ | - | **Miscellaneous Chores** | ❌ |\n| `docs` | ❌ | - | **Documentation** | ❌ |\n| `feat` | ✅ | minor (_v0._**1**_.0_) | **Features** | ✅ |\n| `fix` | ✅ | patch (_v0.0._**1**) | **Bug Fixes** | ✅ |\n| `perf` | ✅ | patch (_v0.0._**1**) | **Performance Improvements** | ✅ |\n| `refactor` | ❌ | - | **Code Refactoring** | ❌ |\n| `revert` | ❌ | - | **Reverts** | ✅ |\n| `style` | ❌ | - | **Styles** | ❌ |\n| `test` | ❌ | - | **Tests** | ❌ |\n\nA special behavior for `BREAKING CHANGE` commits:\n\n| Commit | Trigger release | Version Bump | Changelog Section | Changelog Visibility |\n| ---------------------------------------------------------------------------- | :----------------: | :--------------------: | ------------------------------ | :------------------: |\n| `chore(scope)!: commit message` | ✅ | major (_v_**1**_.0.0_) | **⚠️ BREAKING CHANGES** | ✅ |\n| `perf(scope): commit message`
`BREAKING CHANGE: breaking message` | ✅ | major (_v_**1**_.0.0_) | **⚠️ BREAKING CHANGES** | ✅ |\n\n## Plugins\n\nThis shareable configuration comes with the following **plugins** installed:\n\n- [`@semantic-release/commit-analyzer`](https://github.com/semantic-release/commit-analyzer)\n- [`@semantic-release/release-notes-generator`](https://github.com/semantic-release/release-notes-generator)\n- [`@semantic-release/changelog`](https://github.com/semantic-release/changelog)\n- [`@semantic-release/npm`](https://github.com/semantic-release/npm)\n- [`@semantic-release/github`](https://github.com/semantic-release/github)\n- [`@semantic-release/exec`](https://github.com/semantic-release/exec)\n\nSee each documentation for required installation and configuration steps.\n\n## Install\n\n```bash\nyarn add semantic-release @droplt/semantic-release-config -D\n```\n\n## Usage\n\nThe shareable config can be configured via the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration):\n\n- A `.releaserc` file, written in YAML or JSON, with optional extensions: `.yaml`/`.yml`/`.json`/`.js`\n- A `release.config.js` file that exports an object\n- A `release` key in the project's `package.json` file\n\n```js\n// release.config.js\nmodule.exports = {\n \"extends\": \"@droplt/semantic-release-config\"\n}\n```\n\n```js\n// package.json\n{\n ...\n \"release\": {\n \"extends\": \"@droplt/semantic-release-config\"\n }\n}\n```\n\nUsing a `release.config.js` allow you to customize the default configuration:\n\n```js\nconst config = require('@droplt/semantic-release-config')\n\nmodule.exports = {\n ...config,\n plugins: [\n ...config.plugins,\n 'add_your_plugin_here',\n ...\n ],\n}\n```\n\n## Examples\n\n### Run NPM script before release\n\nUsing the pre-installed `@semantic-release/exec` plugin, you can run a custom **NPM script** before the release process.\n\n```js\n// release.config.js\nconst config = require('@droplt/semantic-release-config')\n\nmodule.exports = {\n ...config,\n plugins: [\n ...config.plugins,\n ['@semantic-release/exec', {\n prepareCmd: 'yarn build',\n }],\n ],\n}\n```\n\n> Refer to [`@semantic-release/exec`](https://github.com/semantic-release/exec#options) documentation for lifecycle hooks.\n","readmeFilename":"README.md"}