Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
webpro committed Feb 25, 2022
1 parent abef409 commit 685e4f1
Showing 1 changed file with 29 additions and 11 deletions.
40 changes: 29 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,24 @@ Default value: `undefined`
- 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`
Expand Down Expand Up @@ -172,25 +190,25 @@ For example, you can use the following option to group the commits by 'scope' in
}
```

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:
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 fs = require('fs');

const commitTemplate = fs.readFileSync("commit.hbs").toString();
const commitTemplate = fs.readFileSync('commit.hbs').toString();

module.exports = {
plugins: {
"@release-it/conventional-changelog": {
writerOpts: {
commitPartial: commitTemplate,
},
},
},
plugins: {
'@release-it/conventional-changelog': {
writerOpts: {
commitPartial: commitTemplate
}
}
}
};
```


## GitHub Actions

When using this plugin in a GitHub Action, make sure to set
Expand Down

0 comments on commit 685e4f1

Please sign in to comment.