feat(CI): add semantic-release process (#1)

* config(CI): add release-process (gh-actions) * config: update to new pckg name * docs: update README
stackr23 · Sep 6, 2021 · 061d2ef · 061d2ef
1 parent 99821c5
commit 061d2ef
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 91 deletions.
diff --git a/.github/workflows/release-process.yml b/.github/workflows/release-process.yml
@@ -0,0 +1,29 @@
+name: Semantic Release
+on:
+  push:
+    branches:
+      - 'main'
+      - 'master'
+    tags-ignore:
+      - '**'
+jobs:
+  semantic_release:
+    name: Semantic Release Process
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Setup Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14
+      - name: Install Semantic Release Packages
+        run: npm i -g @stackr23/preset-conventional-changelog semantic-release @semantic-release/commit-analyzer @semantic-release/release-notes-generator @semantic-release/changelog @semantic-release/npm @semantic-release/git @semantic-release/github
+      - name: Exec Semantic Release
+        run: npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/.releaserc b/.releaserc
@@ -5,7 +5,7 @@
     [
       "@semantic-release/commit-analyzer",
       {
-        "config": "@stackr23/conventional-changelog-config",
+        "config": "@stackr23/preset-conventional-changelog",
         "releaseRules": [
           {"type": "feat", "release": "minor"},
           {"type": "fix", "release": "patch"},
@@ -18,7 +18,7 @@
     ],
     [
       "@semantic-release/release-notes-generator",
-      {"config": "@stackr23/conventional-changelog-config"}
+      {"config": "@stackr23/preset-conventional-changelog"}
     ],
     [
       "@semantic-release/changelog",

diff --git a/README.md b/README.md
@@ -5,9 +5,7 @@
 [semantic-img]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-blue.svg
 [semantic-url]: https://semver.org/
 
-## StackR23 config - based on angular preset
-
-Angular's [commit message guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit).
+## Stackr23's preset for conventional-changelog
 
 ### Type Definitions
 
@@ -22,89 +20,4 @@ Angular's [commit message guidelines](https://github.com/angular/angular/blob/ma
 | **refactor** | :building_construction: Refactoring   | **Structure Improvements**                                        |
 | **test**     | :white_check_mark: Tests              | **changes in Tests**<br/>(_add, upgrade, remove, ..._)            |
 | **docs**     | :memo: Documentations                 | **Documentation changes**<br/>(_README, WIKI, CHANGELOG, ..._)    |
-| **revert**   | :rewind: Reverts                      | **Revert Commit**                                                 |
-
-### Examples
-
-Appears under "Features" header, pencil subheader:
-
-```
-feat(pencil): add 'graphiteWidth' option
-```
-
-Appears under "Bug Fixes" header, graphite subheader, with a link to issue #28:
-
-```
-fix(graphite): stop graphite breaking when width < 0.1
-
-Closes #28
-```
-
-Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:
-
-```
-perf(pencil): remove graphiteWidth option
-
-BREAKING CHANGE: The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reason.
-```
-
-The following commit and commit `667ecc1` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.
-
-```
-revert: feat(pencil): add 'graphiteWidth' option
-
-This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
-```
-
-### Commit Message Format
-
-A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:
-
-```
-<type>(<scope>): <subject>
-<BLANK LINE>
-<body>
-<BLANK LINE>
-<footer>
-```
-
-The **header** is mandatory and the **scope** of the header is optional.
-
-### Revert
-
-If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
-
-### Type
-
-If the prefix is `feat`, `fix` or `perf`, it will appear in the changelog. However if there is any [BREAKING CHANGE](#footer), the commit will always appear in the changelog.
-
-Other prefixes are up to your discretion. Suggested prefixes are `build`, `ci`, `docs` ,`style`, `refactor`, and `test` for non-changelog related tasks.
-
-Details regarding these types can be found in the official [Angular Contributing Guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#type).
-
-### Scope
-
-The scope could be anything specifying place of the commit change. For example `$location`,
-`$browser`, `$compile`, `$rootScope`, `ngHref`, `ngClick`, `ngView`, etc...
-
-### 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
-
-Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
-The body should include the motivation for the change and contrast this with previous behavior.
-
-### Footer
-
-The footer should contain any information about **Breaking Changes** and is also the place to
-reference GitHub issues that this commit **Closes**.
-
-**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
-
-A detailed explanation can be found in this [document](#commit-message-format).
+| **revert**   | :rewind: Reverts                      | **Revert Commit**                                                 |