معرفی شرکت ها
@release-it/conventional-changelog-5.1.1
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Conventional changelog plugin for release-it
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | @release-it/conventional-changelog-5.1.1 |
| نام | @release-it/conventional-changelog |
| نسخه کتابخانه | 5.1.1 |
| نگهدارنده | ['webpro'] |
| ایمیل نگهدارنده | ['lars@webpro.nl'] |
| نویسنده | Lars Kappert |
| ایمیل نویسنده | lars@webpro.nl |
| آدرس صفحه اصلی | git+https://github.com/release-it/conventional-changelog.git |
| آدرس اینترنتی | https://github.com/release-it/conventional-changelog#readme |
| مجوز | MIT |
# Conventional Changelog plugin for release-it
This plugin will provide the recommended bump to release-it, and update the changelog file (e.g. `CHANGELOG.md`).
```
npm install --save-dev @release-it/conventional-changelog
```
## Configuration
In the [release-it](https://github.com/release-it/release-it) config, for example:
```json
"plugins": {
"@release-it/conventional-changelog": {
"preset": "angular",
"infile": "CHANGELOG.md"
}
}
```
Options are passed verbatim to
[conventional-recommended-bump](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-recommended-bump#readme)
and
[conventional-changelog-core](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-core#api).
### `preset`
Use one of:
- `angular`
- `atom`
- `codemirror`
- `conventionalcommits`
- `ember`
- `eslint`
- `express`
- `jquery`
- `jscs`
- `jshint`
Use an object with `name` and `types` to use a custom preset:
```json
"plugins": {
"@release-it/conventional-changelog": {
"infile": "CHANGELOG.md",
"preset": {
"name": "conventionalcommits",
"types": [
{
"type": "feat",
"section": "Features"
},
{
"type": "fix",
"section": "Bug Fixes"
},
{}
]
}
}
}
```
See the
[Conventional Changelog Configuration Spec (v2.1.0)](https://github.com/conventional-changelog/conventional-changelog-config-spec/blob/master/versions/2.1.0/README.md)
for the configuration object to pass as `preset`.
### `infile`
Default value: `undefined`
- Set a filename as `infile` to write the changelog to. If this file does not exist yet, it's created with the full
history.
- When `infile` is not set, the changelog generated by this plugin will still be used as release notes for e.g.
[GitHub Releases](https://github.com/release-it/release-it/blob/master/docs/github-releases.md).
### `header`
Set the main header for the changelog document:
```json
{
"plugins": {
"@release-it/conventional-changelog": {
"infile": "CHANGELOG.md",
"header": "# Changelog",
"preset": {
"name": "conventionalcommits"
}
}
}
}
```
### `ignoreRecommendedBump`
Default value: `false`
Use `true` to ignore the recommended bump, and use the version provided by release-it (command line argument or prompt).
(Note that the changelog preview shows the recommended bump, as the desired version isn't known yet. The `infile` will
have the correct version.)
### `strictSemVer`
Default value: `false`
Use `true` to strictly follow semver, also in consecutive pre-releases. This means that from a pre-release, a
recommended bump will result in a next pre-release for the next version. For example, from `1.0.0-alpha.0` a recommended
bump of `minor` will result in a `preminor` bump to `1.1.0-alpha.0` (whereas the default behavior without this flag
results in a `prerelease` bump to `1.0.0-alpha.1`).
### `context`
Default value: `undefined`
This option will be passed as the second argument (`context`) to
[conventional-changelog-core](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-core#context),
for example:
```json
"plugins": {
"@release-it/conventional-changelog": {
"context": {
"linkCompare": false
}
}
}
```
### `gitRawCommitsOpts`
Default value: `undefined`
Options for
[`git-raw-commits`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/git-raw-commits#api).
For example, you can use the following option to include merge commits into changelog:
```json
{
"plugins": {
"@release-it/conventional-changelog": {
"gitRawCommitsOpts": {
"merges": null
}
}
}
}
```
### `parserOpts`
Default value: `undefined`
Options for
[`conventional-commits-parser`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser#api).
For example, you can use the following option to set the merge pattern during parsing the commit message:
```json
{
"plugins": {
"@release-it/conventional-changelog": {
"parserOpts": {
"mergePattern": "^Merge pull request #(\\d+) from (.*)$"
}
}
}
}
```
### `writerOpts`
Default value: `undefined`
Options for
[`conventional-changelog-writer`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-writer#api).
For example, you can use the following option to group the commits by 'scope' instead of 'type' by default.
```json
{
"plugins": {
"@release-it/conventional-changelog": {
"writerOpts": {
"groupBy:" "scope"
}
}
}
}
```
If you want to customize the templates used to write the changelog, you can do it like in a `.release-it.js` file like
so:
```js
const fs = require('fs');
const commitTemplate = fs.readFileSync('commit.hbs').toString();
module.exports = {
plugins: {
'@release-it/conventional-changelog': {
writerOpts: {
commitPartial: commitTemplate
}
}
}
};
```
## GitHub Actions
When using this plugin in a GitHub Action, make sure to set
[`fetch-depth: 0`](https://github.com/actions/checkout#fetch-all-history-for-all-tags-and-branches) so the history is
available to determine the correct recommended bump and changelog.
Also see https://github.com/release-it/release-it/blob/master/docs/ci.md#github-actions
نیازمندی
| مقدار | نام |
|---|---|
| ^2.0.0 | concat-stream |
| ^3.1.25 | conventional-changelog |
| ^6.1.0 | conventional-recommended-bump |
| 7.3.8 | semver |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| 16.17.1 | Npm |
نحوه نصب
نصب پکیج tgz @release-it/conventional-changelog-5.1.1:
npm install @release-it/conventional-changelog-5.1.1.tgz