Skip to content

Commit

Permalink
fmt
Browse files Browse the repository at this point in the history
  • Loading branch information
sylc committed Jun 2, 2022
1 parent b880b6b commit 165db7c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ matching the plugin. Example of configuration.
### Baked-in plugins

- [github](./doc/doc.md#github): Create a release on Github.
- [changelog](./doc/doc.md#changelog): Create a changelog based on
filtered commits.
- [changelog](./doc/doc.md#changelog): Create a changelog based on filtered
commits.
- [regex](./doc/doc.md#changelog): Apply a regex on `README.md`
- [versionFile](./plugins/versionFile/mod.ts): Create a `version.json` file with
the new version number.
Expand Down
13 changes: 7 additions & 6 deletions doc/doc.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Changelog

Changelog creates a file called `CHANGELOG.md`. Only commits
starting with `feat` and `fix` and `breaking` will be showing up
Changelog creates a file called `CHANGELOG.md`. Only commits starting with
`feat` and `fix` and `breaking` will be showing up

# Github

The github plugin create github release.
Releases can be created as `draft`
The github plugin create github release. Releases can be created as `draft`

Only commits starting with `feat` and `fix` and `breaking` will appear in the release change log
Only commits starting with `feat` and `fix` and `breaking` will appear in the
release change log

```ts
interface GithubConfig {
Expand All @@ -23,7 +23,8 @@ interface GithubConfig {

# Regex

Apply a regex on the `README.md`. The regex can be configure in the config file. e.g:
Apply a regex on the `README.md`. The regex can be configure in the config file.
e.g:

```json
"regex": {
Expand Down

0 comments on commit 165db7c

Please sign in to comment.