Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
sylc committed Jun 2, 2022
1 parent f451a94 commit 25089a6
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 8 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,13 @@ matching the plugin. Example of configuration.

### Baked-in plugins

- [github](./plugin/github/mod.ts): Create a draft release on Github.
- [changelog](./plugin/changelog/README>md): Create a changelog based on
- [github](./doc/doc.md#github): Create a release on Github.
- [changelog](./doc/doc.md#changelog): Create a changelog based on
filtered commits.
- [regex](./plugin/regex/mod.ts): Apply a regex on the Readme the regex can be
- [regex](./plugins/regex/mod.ts): Apply a regex on the Readme the regex can be
configure in the config file. For to update the version number following `@`
to the new one.
- [versionFile](./plugin/versionFile/mod.ts): Create a `version.json` file with
- [versionFile](./plugins/versionFile/mod.ts): Create a `version.json` file with
the new version number.

### Remote plugins
Expand Down
12 changes: 12 additions & 0 deletions doc/doc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Changelog

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`

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

4 changes: 0 additions & 4 deletions plugins/changelog/README.md

This file was deleted.

0 comments on commit 25089a6

Please sign in to comment.