diff --git a/README.md b/README.md index b47a68e..6b74dd3 100644 --- a/README.md +++ b/README.md @@ -62,9 +62,7 @@ matching the plugin. Example of configuration. - [github](./doc/doc.md#github): Create a release on Github. - [changelog](./doc/doc.md#changelog): Create a changelog based on filtered commits. -- [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. +- [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. diff --git a/doc/doc.md b/doc/doc.md index 978b534..0e763c2 100644 --- a/doc/doc.md +++ b/doc/doc.md @@ -10,3 +10,26 @@ Releases can be created as `draft` Only commits starting with `feat` and `fix` and `breaking` will appear in the release change log +```ts +interface GithubConfig { + github: { + /** + * Perform a release. Can also be set to 'draft' to performa draft release + */ + release?: boolean | "draft"; + }; +} +``` + +# Regex + +Apply a regex on the `README.md`. The regex can be configure in the config file. e.g: + +```json +"regex": { + "patterns": [ + "/(?<=@)(.*)(?=\/)/gm", + "(?<=release-me\/)(.*)(?=\/cli)" + ] + }, +```