Skip to content

Commit

Permalink
feat: changelog doc (#9)
Browse files Browse the repository at this point in the history
* remove test file

* x

* fmt
  • Loading branch information
sylc committed Jun 1, 2022
1 parent 7f27656 commit 1f041eb
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 11 deletions.
5 changes: 1 addition & 4 deletions .release-me.json
Expand Up @@ -9,8 +9,5 @@
"(?<=release-me\/)(.*)(?=\/cli)"
]
},
"versionFile": {},
"testRemote": {
"path": "./plugins/testRemote/mod.ts"
}
"versionFile": {}
}
9 changes: 5 additions & 4 deletions README.md
Expand Up @@ -59,13 +59,14 @@ matching the plugin. Example of configuration.

### Baked-in plugins

- [github](./plugin/github/mod.ts): Create a draft release on Github
- [changelog](./plugin/changelog/mod.ts): Create a changelog
- [github](./plugin/github/mod.ts): Create a draft release on Github.
- [changelog](./plugin/changelog/README>md): Create a changelog based on
filtered commits.
- [regex](./plugin/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
to the new one.
- [versionFile](./plugin/versionFile/mod.ts): Create a `version.json` file with
the new version number
the new version number.

### Remote plugins

Expand Down
4 changes: 4 additions & 0 deletions plugins/changelog/README.md
@@ -0,0 +1,4 @@
# Changelog

Changelog creates a file called CHANGELOG.md. It is currently filtering commits
starting with `feat` and `fix`
3 changes: 0 additions & 3 deletions versionTest.json

This file was deleted.

0 comments on commit 1f041eb

Please sign in to comment.