fix(ci-cd): add changelog feature

gh-0
sourcefuse · Jul 24, 2021 · 33304d1 · 33304d1
1 parent d12a83f
commit 33304d1
Show file tree

Hide file tree

Showing 4 changed files with 107 additions and 2 deletions.
diff --git a/DEVELOPING.md b/DEVELOPING.md
@@ -7,8 +7,8 @@ users.
 
 Install the following extensions:
 
- - [eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
- - [prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
+- [eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+- [prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
 
 ## Development workflow
 
@@ -34,3 +34,91 @@ Install the following extensions:
    suite and lint the code for both programming and style errors. You should run
    this command manually whenever you have new changes to test. Test failures
    and linter errors will be printed to the terminal.
+
+## Commit message guidelines
+
+A good commit message should describe what changed and why.
+
+Our commit messages are formatted according to
+[Conventional Commits](https://conventionalcommits.org/), we use
+[commitlint](https://github.com/marionebl/commitlint) to verify and enforce this
+convention. These rules lead to more readable messages that are easy to follow
+when looking through the project history. But also, we use the git commit
+messages to generate change logs when publishing new versions.
+
+### Commit Message Format
+
+Each commit message consists of a **header**, a **body** and a **footer**. The
+header has a special format that includes a **type**, an optional **scope** and
+a **subject**:
+
+```text
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+#### type
+
+The **type** must be one of the following:
+
+- **feat**: A new feature
+- **fix**: A bug fix
+- **docs**: Documentation only changes
+- **style**: Changes that do not affect the meaning of the code (white-space,
+  formatting, missing semi-colons, etc)
+- **refactor**: A code change that neither fixes a bug nor adds a feature
+- **perf**: A code change that improves performance
+- **test**: Adding missing or correcting existing tests
+- **build**: Changes that affect the build system or external dependencies
+- **ci**: Changes to our CI configuration files and scripts
+- **chore**: Changes to the auxiliary tools and libraries such as documentation
+  generation
+- **revert**: Reverts a previous commit
+
+#### scope
+
+The **scope** must be a list of one or more modules contained in this repo.
+
+#### subject
+
+The **subject** contains succinct description of the change:
+
+- use the imperative, present tense: "change" not "changed" nor "changes"
+- don't capitalize first letter
+- no dot (.) at the end
+
+#### body
+
+The **body** provides more details, it should include the motivation for the
+change and contrast this with previous behavior.
+
+Just as in the subject, use the imperative, present tense: "change" not
+"changed" nor "changes"a
+
+Paragraphs or bullet points are ok (must not exceed 100 characters per line).
+Typically a hyphen or asterisk is used for the bullet, followed by a single
+space, with blank lines in between.
+
+#### references
+
+Its mandatory to add references to JIRA ticket you are resolving as part of the commit.
+
+#### footer (optional)
+
+The **footer** should contain any information about Breaking Changes introduced
+by this commit.
+
+This section must start with the upper case text `BREAKING CHANGE` followed by a
+colon (`:`) and a space (``). A description must be provided, describing what
+has changed and how to migrate from older versions.
+
+### Tools to help generate a commit message
+
+This repository has [commitizen](https://github.com/commitizen/cz-cli) support
+enabled. Commitizen can help you generate your commit messages automatically.
+
+And to use it, simply call `git commit`. The tool will help
+you generate a commit message that follows the above guidelines.
diff --git a/README.md b/README.md
@@ -45,6 +45,10 @@ If you think this extension is useful, please [star](https://help.github.com/en/
 
 Please read [CONTRIBUTING.md](https://github.com/sourcefuse/loopback4-s3/blob/master/.github/CONTRIBUTING.md) for details on the process for submitting pull requests to us.
 
+## Developing
+
+For development guidelines, refer [here](https://github.com/sourcefuse/rakuten-pms-api/tree/master/DEVELOPING.md)
+
 ## Code of conduct
 
 Code of conduct guidelines [here](https://github.com/sourcefuse/loopback4-s3/blob/master/.github/CODE_OF_CONDUCT.md).

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -55,6 +55,7 @@
     "@loopback/build": "^6.4.0",
     "@loopback/eslint-config": "^10.2.0",
     "@loopback/testlab": "^3.4.0",
+    "@semantic-release/changelog": "^5.0.1",
     "@types/moment-timezone": "^0.5.12",
     "@types/node": "^10.17.60",
     "@typescript-eslint/eslint-plugin": "^4.24.0",