From 91b6f1cd16b680519e95eb02f5c6fa907477dc82 Mon Sep 17 00:00:00 2001
From: Hugo SUBTIL <ext.sopra.husubtil@grandlyon.com>
Date: Thu, 15 Jul 2021 16:01:58 +0200
Subject: [PATCH] feat: add standard-version release doc
---
docs/ecolyo/application/release.md | 40 ++++++++++++++++++++++++++++++
mkdocs.yml | 5 ++--
2 files changed, 43 insertions(+), 2 deletions(-)
create mode 100644 docs/ecolyo/application/release.md
diff --git a/docs/ecolyo/application/release.md b/docs/ecolyo/application/release.md
new file mode 100644
index 0000000..90bc6d1
--- /dev/null
+++ b/docs/ecolyo/application/release.md
@@ -0,0 +1,40 @@
+# Release
+
+This section will show you how to properly create a release for the app.
+
+## Conventionnal commit
+
+The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages.
+
+The commit message should be structured as follows:
+
+```
+<type>[optional scope]: <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+The commit contains the following structural elements, to communicate intent to the consumers of your library:
+
+* fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
+* feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
+* BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.
+* types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others.
+* footers other than BREAKING CHANGE: <description> may be provided and follow a convention similar to git trailer format.
+
+## standard-version
+
+Standard-version is librairie javascript that allow to handle easly tags and changelog file.
+
+Just run the following command in order to create a release tag, bump package.json version and upadte changelog file.
+
+```bash
+yarn run release -- --release-as X.X.X # replace with version number (ex: 1.2.0)
+```
+
+## Usefull links
+[Conventional commit doc](https://www.conventionalcommits.org/en/v1.0.0/)
+
+[Lib link](https://github.com/conventional-changelog/standard-version)
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index fab28c3..6599ccd 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -43,12 +43,13 @@ nav:
- DocTypes: ecolyo/project_architecture/doctypes.md
- Remote DocTypes: ecolyo/project_architecture/remote_doctypes.md
- Application:
+ - Deploy: ecolyo/application/deploy.md
- Description: ecolyo/application/description.md
+ - Gitflow: ecolyo/application/gitflow.md
- Redux: ecolyo/application/redux.md
+ - Release: ecolyo/application/release.md
- Scaffolding: ecolyo/application/scaffolding.md
- Services: ecolyo/application/services.md
- - Gitflow: ecolyo/application/gitflow.md
- - Deploy: ecolyo/application/deploy.md
- Services:
- Description: ecolyo/services/index.md
- Monthly report notification: ecolyo/services/monthly_report_notification.md
--
GitLab