From 2c53dcdc2c9fefb93e4422440a28cf44cc2891a9 Mon Sep 17 00:00:00 2001 From: nicmosc Date: Wed, 6 May 2020 14:47:34 +0200 Subject: [PATCH] fix: add doc about releasing --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 84ea242..0a02d1a 100644 --- a/README.md +++ b/README.md @@ -76,6 +76,12 @@ To run the integration tests simply run $ npm run test ``` +## Releasing +Releasing is done automatically through the commit messages: `fix: [content]` will trigger a patch, `feature: [content]` will trigger a minor, and `breaking: [content]` will trigger a major. You can read more about it [here](https://semantic-release.gitbook.io/semantic-release/#how-does-it-work). +```bash +$ npx semantic-release +``` + ## VSCode Depending on your personal configuration, you can enable vscode to report deprecation usage through the plugin. If you already have the ESLint plugin installed and enabled, the deprecation rules should work automatically.