Merge pull request #1 from abusix/pla-509-common-platform-repo-config

Add npm semantic-release workflow

.github/workflows/release.yml

@@ -0,0 +1,25 @@
+name: Semantic Release CI
+
+on:
+  push:
+    branches: [main]
+
+env:
+  GH_TOKEN: ${{ secrets.GH_TOKEN }}
+  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          persist-credentials: false # <--- this
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: "npm"
+      - run: npm ci
+      - run: npm run build
+      - run: npx semantic-release

.releaserc

@@ -0,0 +1,20 @@
+{
+  "branches": ["main"],
+  "debug": true,
+  "ci": true,
+  "dryRun": false,
+  "plugins":
+    [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      ["@semantic-release/npm", { "npmPublish": true, "tarballDir": "dist" }],
+      "@semantic-release/github",
+      [
+        "@semantic-release/git",
+        {
+          "assets": ["package.json", "package-lock.json", "CHANGELOG.md"],
+          "message": "chore(release): ${nextRelease.version} [skip ci]",
+        },
+      ],
+    ],
+}

README.md

@@ -3,9 +3,11 @@
 Code conventions for Abusix repos and projects. 
 
 
-## Available Eslint Packages
+## Available Config Packages
 
-This repo includes the eslint packages:
+**⚠️ Note: Please make sure to have the required peer dependencies installed in your project.**
+
+This repo includes these eslint packages:
 
 ### eslint-config-base
 
@@ -25,4 +27,64 @@ Add the following to your `.eslintrc.js`:
 module.exports = {
   extends: ['@abusix/eslint-config-base'],
 };
+```
+
+### eslint-config-react
+
+This package contains the base eslint configuration for react + typescript projects.
+
+#### Installation
+
+```sh
+npm add -D @abusix/eslint-config-react
+```
+
+#### Usage
+
+Add the following to your `.eslintrc.js`:
+
+```js
+module.exports = {
+  extends: ['@abusix/eslint-config-react'],
+};
+```
+
+### eslint-config-prettier
+
+This package contains a prettier config used by eslint.  
+
+#### Installation
+
+```sh
+npm add -D @abusix/eslint-config-prettier
+```
+
+#### Usage
+
+Add the following to your `.eslintrc.js`:
+
+```js
+module.exports = {
+  extends: ['@abusix/eslint-config-prettier'],
+};
+```
+
+### eslint-config-storybook
+
+This package contains the base eslint configuration for storybook + typescript projects.
+
+#### Installation
+
+```sh
+npm add -D @abusix/eslint-config-storybook
+```
+
+#### Usage
+
+Add the following to your `.eslintrc.js`:
+
+```js
+module.exports = {
+  extends: ['@abusix/eslint-config-storybook'],
+};
 ```