From 628965b6fcd92490c9293fc2aefe50852e58f818 Mon Sep 17 00:00:00 2001 From: Xavi Date: Sat, 30 May 2020 21:58:41 +0200 Subject: [PATCH] docs(CONTRIBUTING.md): add deployment instructions --- CONTRIBUTING.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7ceadc59..3f3d02cd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -65,7 +65,24 @@ bundle exec jekyll serve ## Pull request Feel free to open a PR on GitHub. When submitting the PR several points will be checked: + - Testing (with pytest) - Linting (with flake8) - Typing (with mypy) -- Formatting (with black) \ No newline at end of file +- Formatting (with black) + +## Deployment + +Thanks to the Azure Pipelines, we are able to deploy by just creating a new tag on git. So first, we will need to bump version with `commitizen` by running the following line in the `master` branch: + +``` +cz bump --no-verify +``` + +Then, we can directly push the tags: + +``` +git push origin master --tags +``` + +This will automatically generate a GitHub release with the changes for that release.