init(init): first commit

Author: GregoireF

.dockerignore

@@ -1,3 +1,5 @@
 node_modules
 npm-debug.log
 npm-error.log
+yarn-debug.log
+yarn-error.log

.github/config/labels.yml

@@ -1,132 +1,132 @@
 ---
-- name: approved-review
+- name: ✔️ approved-review
  color: '71FFA4'
  description: Review approved and PR ready to merge
 
-- name: awaiting-review
+- name: ⌛ awaiting-review
  color: 'E3A466'
  description: PR awaiting for review
 
-- name: blocked-review
+- name: ⛔ blocked-review
  color: 'E64320'
  description: Review blocked (specify why in comments)
 
-- name: bug
+- name: 🐛 bug
  color: 'E64320'
  description: Suspected/confirmed bug
 
-- name: chore
+- name: 🚧 chore
  color: 'E3A466'
  description: Tedious but necessary task
 
-- name: conflicts
+- name: ⛔ conflicts
  color: 'E67F03'
  description: Merge conflicts to be resolved by the author of the PR
 
-- name: discussion
+- name: 📝 discussion
  color: '78A5FF'
  description: Invite to discussion of collaborators
 
-- name: duplicate
+- name: ❌ duplicate
  color: 'FFFFFF'
  description: Duplicated issue link to the issue in comments
 
-- name: enhancement
+- name: 💡 enhancement
  color: '71FFA4'
  description: Improvement of existing code
 
-- name: big-enhancement
+- name: 💣 big-enhancement
  color: '00FF62'
  description: Epic improvement deserving a full release
 
-- name: ext-dependency
+- name: 🎉 ext-dependency
  color: 'E64320'
  description: Third-party dependency problem can't fix by our own
 
-- name: help-needed
+- name: 🆘 help-needed
  color: '78A5FF'
  description: Issue author is asking for help
 
-- name: in-progress
+- name: ⌛ in-progress
  color: '71FFA4'
  description: Issue is currently worked on
 
-- name: in-review
+- name: ⌛ in-review
  color: '71FFA4'
  description: Issue is currently reviewed
 
-- name: low-priority
+- name: ⚠️ low-priority
  color: '71FFA4'
  description: Non-urgent changes and future ideas
 
-- name: medium-priority
+- name: ⚠️ medium-priority
  color: 'E3A466'
  description: Can be worked on later
 
-- name: high-priority
+- name: ⚠️ high-priority
  color: 'E64320'
  description: Need to be worked on ASAP
 
-- name: critical-priority
+- name: ⚠️ critical-priority
  color: '000000'
  description: Stop all work in progress and work on this (to be used when REALLY necessary!)
 
-- name: question
+- name: ❓ question
  color: 'E3A466'
  description: Question awaiting answer before continuing to advance on the issue
 
-- name: research-needed
+- name: ⌛ research-needed
  color: '78A5FF'
  description: Research required be clear and concise
 
-- name: beginner
+- name: 🔰 beginner
  color: '71FFA4'
  description: Issue that can be resolved by beginners
 
-- name: intermediate
+- name: 🔰 intermediate
  color: 'E3A466'
  description: Issue requiring at least intermediate developers
 
-- name: advanced
+- name: 🔰 advanced
  color: 'E67F03'
  description: Issue requiring at least advanced developers
 
-- name: expert
+- name: 🔰 expert
  color: 'E64320'
  description: Issue requiring expert developers
 
-- name: feature
+- name: ⭐ feature
  color: '78A5FF'
  description: Functionnality request changes, improvements, additions, etc
 
-- name: blocked
+- name: ⛔ blocked
  color: 'EEEEEE'
  description: Is blocked by another issue (specify which in comments)
 
-- name: blocker
+- name: ⛔ blocker
  color: '000000'
  description: Blocks the progress of an issue requires special attention(specify which in comments)
 
-- name: windows
+- name: 🖥️ windows
  color: '2E95D1'
  description: Under Windows OS
 
-- name: macos
+- name: 🍎 macos
  color: '2E95D1'
  description: Under MacOS
 
-- name: linux
+- name: 🐧 linux
  color: '2E95D1'
  description: Under Linux OS
 
-- name: admin-task
+- name: 🚀 admin-task
  color: 'E64320'
  description: Task requiring an administrator
 
-- name: technical-task
+- name: 🚀 technical-task
  color: 'E67F03'
  description: Task requiring technical work
 
-- name: design-task
+- name: 🚀 design-task
  color: 'E67F03'
  description: Task requiring design work

.github/workflows/pipeline-release.yml

@@ -1,30 +1,24 @@
-name: Create Release - Pipeline
-
+name: Node.js Package
 on:
- push:
- tags:
-  - '*'
+ release:
+ types: [created]
+ workflow_dispatch:
 
 jobs:
- create-changelog:
+ build:
  runs-on: ubuntu-latest
-
+ permissions:
+ contents: read
+ packages: write
  steps:
- - name: Checkout
- uses: actions/checkout@v2
-
- - name: Create changelog text
- id: changelog
- uses: loopwerk/tag-changelog@v1
+ - uses: actions/checkout@v2
+ # Setup .npmrc file to publish to npm
+ - uses: actions/setup-node@v2
  with:
- token: ${{ secrets.GITHUB_TOKEN }}
- config_file: .github/config/tag-changelog-config.js
-
- - name: Create release
-  uses: actions/create-release@latest
+ node-version: '14.x'
+ registry-url: 'https://registry.npmjs.org'
+ - run: yarn
+ # Publish to npm
+ - run: yarn publish --access public
  env:
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- with:
- tag_name: ${{ github.ref }}
- release_name: Release ${{ github.ref }}
- body: ${{ steps.changelog.outputs.changes }}
+ NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.husky/commit-msg

@@ -1,7 +1,7 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-#yarn commitlint -e $HUSKY_GIT_PARAMS
+yarn commitlint -e $HUSKY_GIT_PARAMS
 
 SIGNATURE="Signed-off-by: `git config --global --get user.name` <`git config --global --get user.email`>"
 grep -qs "^${SIGNATURE}" "$1" || echo "\n${SIGNATURE}" >> "$1"

README.md

@@ -1,26 +1,29 @@
-# [github-template](https://github.com/WebReadyProjects/github-template/)
+# [cz-changelog-wrprojects](https://github.com/WebReadyProjects/cz-changelog-wrprojects/)
 
 <p align="center">
  <a href="https://github.com/WebReadyProjects" target="_blank">
- <img src="https://avatars.githubusercontent.com/u/84878971?s=200&v=4" alt="WebReady Projects Logo" width="100">
+ <img src="http://image.noelshack.com/fichiers/2021/48/6/1638580676-component-39-3.png" alt="WebReady Projects Logo" width="800">
  </a>
 </p>
 
 <p align="center">
- <a href="https://github.com/WebReadyProjects/github-template/releases">
- <img src="https://img.shields.io/github/package-json/v/WebReadyProjects/github-template?style=flat-square" alt="Version badge">
+ <a href="https://github.com/WebReadyProjects/cz-changelog-wrprojects/releases">
+ <img src="https://img.shields.io/github/package-json/v/WebReadyProjects/cz-changelog-wrprojects?style=flat-square" alt="Version badge">
  </a>
- <a href="https://github.com/WebReadyProjects/github-template/">
+ <a href="https://github.com/WebReadyProjects/cz-changelog-wrprojects/">
  <img src="https://img.shields.io/maintenance/yes/2021?style=flat-square" alt="Maintenance badge">
  </a>
  <a href="">
- <img src="https://img.shields.io/github/workflow/status/WebReadyProjects/github-template/Deployment%20-%20Pipeline?style=flat-square" alt="Deployment - Pipeline">
+ <img src="https://img.shields.io/github/workflow/status/WebReadyProjects/cz-changelog-wrprojects/Deployment%20-%20Pipeline?style=flat-square" alt="Deployment - Pipeline">
  </a>
  <a href="">
- <img src="https://img.shields.io/github/downloads/WebReadyProjects/github-template/total?style=flat-square" alt="Downloads GitHub">
+ <img src="https://img.shields.io/github/downloads/WebReadyProjects/cz-changelog-wrprojects/total?style=flat-square" alt="Downloads GitHub">
  </a>
- <a href="https://github.com/WebReadyProjects/github-template/blob/main/LICENSE">
- <img src="https://img.shields.io/github/license/WebReadyProjects/github-template?style=flat-square" alt="License badge">
+ <a href="">
+ <img src="https://img.shields.io/npm/dw/cz-changelog-wrprojects?style=flat-square" alt="Downloads NPM">
+ </a>
+ <a href="https://github.com/WebReadyProjects/cz-changelog-wrprojects/blob/main/LICENSE">
+ <img src="https://img.shields.io/github/license/WebReadyProjects/cz-changelog-wrprojects?style=flat-square" alt="License badge">
  </a>
  <a href="https://discord.com/channels/849073103984525323/849088247987437579">
  <img src="https://img.shields.io/discord/849073103984525323?style=flat-square" alt="Discord badge">
@@ -29,57 +32,56 @@
 
 ## Introduction
 
-[github-template](https://github.com/WebReadyProjects/github-template/) is a GitHub template developed by [Grégoire FAVREAU](https://github.com/GregoireF) to provide [WebReady Projects](https://github.com/WebReadyProjects/) with a solid base respecting many standards and conventions as well as several powerful workflows on all projects.
+[cz-changelog-wrprojects](https://github.com/WebReadyProjects/cz-changelog-wrprojects/) is a package developed by [Grégoire FAVREAU](https://github.com/GregoireF) to provide [WebReady Projects](https://github.com/WebReadyProjects/) with a solid base respecting [GitHub commits conventions](https://www.conventionalcommits.org/en/v1.0.0/) on all projects. The tools that have been used for the production of this package are
+
+- [CommitLint](https://commitlint.js.org/#/)
+- [Commitizen](https://commitizen-tools.github.io/commitizen/)
+- [Husky](https://typicode.github.io/husky/#/)
+
+Also, [WebReady Projects](https://github.com/WebReadyProjects/) works in parallel with GitHub Actions as well to assist in time-intensive steps.
+
+## Ecosystem
+
+| Dependencies | Version |
+| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------- |
+| ![conventional changelog conventionalcommits](https://img.shields.io/github/package-json/dependency-version/WebReadyProjects/cz-changelog-wrprojects/conventional-changelog-conventionalcommits?style=flat-square) | conventional-changelog-conventionalcommits |
+| ![conventional commit types](https://img.shields.io/github/package-json/dependency-version/WebReadyProjects/cz-changelog-wrprojects/conventional-commit-types?style=flat-square) | conventional-commit-types |
+| ![cz conventional changelog](https://img.shields.io/github/package-json/dependency-version/WebReadyProjects/cz-changelog-wrprojects/cz-conventional-changelog?style=flat-square) | cz-conventional-changelog |
+| ![husky ](https://img.shields.io/github/package-json/dependency-version/WebReadyProjects/cz-changelog-wrprojects/husky?style=flat-square) | husky |
+| ![lodash map](https://img.shields.io/github/package-json/dependency-version/WebReadyProjects/cz-changelog-wrprojects/lodash.map?style=flat-square) | lodash.map |
+| ![longest ](https://img.shields.io/github/package-json/dependency-version/WebReadyProjects/cz-changelog-wrprojects/longest?style=flat-square) | longest |
+| ![right pad](https://img.shields.io/github/package-json/dependency-version/WebReadyProjects/cz-changelog-wrprojects/right-pad?style=flat-square) | right-pad |
+| ![word wrap](https://img.shields.io/github/package-json/dependency-version/WebReadyProjects/cz-changelog-wrprojects/word-wrap?style=flat-square) | word-wrap |
 
 ## Installation
 
-In order to use it, you can simply fork the project where you want to start your code in your newly created workspace.
-Once this is done, you need to configure the secrets:
-- Key name: `GITGUARDIAN_API_KEY` | Where to generate the key: [here](https://www.gitguardian.com/)
-- Key name: `METRICS_TOKEN` | Where to generate the key: [here](https://github.com/lowlighter/metrics)
-- Key name: `NPM_TOKEN` | Where to generate the key: [here](https://www.npmjs.com/)
-- Key name: `GIPHY_API_KEY` | Where to generate the key: [here](https://developers.giphy.com/dashboard/)
-
-In order for [Pipeline - Metrics](https://github.com/WebReadyProjects/github-template/actions/workflows/pipeline-metrics.yml) to be clean, we have to use a Gist configuration provided by [lowlighter](https://github.com/lowlighter/), so it is necessary to follow [the configuration scheme](https://github.com/lowlighter/metrics). Once you have created your different Gist, you need to configure them in the [pipeline-metrics.yml](https://github.com/WebReadyProjects/github-template/blob/main/.github/workflows/pipeline-metrics.yml) file like this:
-```yml
- with:
- committer_gist: 8e01675010ff637355609641fd57fe23 # your gist id as shown in gist url
- output_action: gist
+In order to use this package, it is necessary to follow the steps described below:
+
+```sh
+$ yarn add @webreadyprojects/cz-changelog-wrprojects
+OR
+$ npm install @webreadyprojects/cz-changelog-wrprojects
 ```
 
 ## Questions
 
-If you have a question or need help, feel free to use the [GitHub Community Chat](https://github.com/WebReadyProjects/github-template/discussions) or our [Discord](https://discord.com/channels/849073103984525323/849088247987437579) to get support. [GitHub Issues](https://github.com/WebReadyProjects/github-template/issues) and [GitHub Pull Request](https://github.com/WebReadyProjects/github-template/pulls) are exclusively for bug reports or development.
-
-<p align="center">
- <img src="https://raw.githubusercontent.com/gist/GregoireF/caf930c995804d565ffc9bb85fe79f8c/raw/262df8828ba3422594b26faa58413d671c428137/github-metrics.svg" alt="Metric Discussions">
-</p>
+If you have a question or need help, feel free to use the [GitHub Community Chat](https://github.com/WebReadyProjects/cz-changelog-wrprojects/discussions) or our [Discord](https://discord.com/channels/849073103984525323/849088247987437579) to get support. [GitHub Issues](https://github.com/WebReadyProjects/cz-changelog-wrprojects/issues) and [GitHub Pull Request](https://github.com/WebReadyProjects/cz-changelog-wrprojects/pulls) are exclusively for bug reports or development.
 
 ## Issues
 
-It is necessary to read [contribution information](https://github.com/WebReadyProjects/github-template/blob/main/.github/docs/CONTRIBUTION.md) before submitting any type of incident on GitHub, otherwise it will be closed automatically if it does not meet the community conditions.
+It is necessary to read [contribution information](https://github.com/WebReadyProjects/cz-changelog-wrprojects/blob/main/.github/docs/CONTRIBUTION.md) before submitting any type of incident on GitHub, otherwise it will be closed automatically if it does not meet the community conditions.
 
 ## Changelog
 
-Detailed changes for each release are documented in the [release notes](https://github.com/WebReadyProjects/github-template/releases).
+Detailed changes for each release are documented in the [release notes](https://github.com/WebReadyProjects/cz-changelog-wrprojects/releases).
 
 ## Contributing
 
-If you are interested in joining our team of open-source developers, please see the [CONTRIBUTION GUIDE](https://github.com/WebReadyProjects/github-template/blob/main/.github/docs/CONTRIBUTION.md) and the [CODE OF CONDUCT](https://github.com/WebReadyProjects/github-template/blob/main/.github/CODE_OF_CONDUCT.md).
-If this is your first contribution for you, we have [a very fun tutorial](https://github.com/WebReadyProjects/first-contributions) for you, promise, it won't be long! Also, if you need support, feel free to use [our GitHub chat](https://github.com/WebReadyProjects/github-template/discussions) as well as [our Discord](https://discord.com/channels/849073103984525323/849088247987437579).
+If you are interested in joining our team of open-source developers, please see the [CONTRIBUTION GUIDE](https://github.com/WebReadyProjects/cz-changelog-wrprojects/blob/main/.github/docs/CONTRIBUTION.md) and the [CODE OF CONDUCT](https://github.com/WebReadyProjects/cz-changelog-wrprojects/blob/main/.github/CODE_OF_CONDUCT.md).
+If this is your first contribution for you, we have [a very fun tutorial](https://github.com/WebReadyProjects/first-contributions) for you, promise, it won't be long! Also, if you need support, feel free to use [our GitHub chat](https://github.com/WebReadyProjects/cz-changelog-wrprojects/discussions) as well as [our Discord](https://discord.com/channels/849073103984525323/849088247987437579).
 Also, feel free to look at [community incidents]() already present that may answer your question.
 
-<p align="center">
- <img src="https://raw.githubusercontent.com/gist/GregoireF/8e01675010ff637355609641fd57fe23/raw/c543ddeceee0dacc98cdbf9734d0bf0c3d128333/github-metrics.svg" alt="Metric Contributors">
-</p>
-
-## Sponsors & Special Thanks
-
-<p align="center">
- <img src="https://raw.githubusercontent.com/gist/GregoireF/378434b35316787dfce1929deba1721c/raw/bcdbe5641d694442f59f664b96c41374e3ef9038/github-metrics.svg" alt="Special Thanks">
-</p>
-
 ## License
 
-[Apache-2.0](https://github.com/WebReadyProjects/github-template/blob/main/LICENSE)
+[Apache-2.0](https://github.com/WebReadyProjects/cz-changelog-wrprojects/blob/main/LICENSE)
 Copyright (c) 2021-present WebReady Projects