chore: npm publish eslint-config-ivy

Author: yeslee-houzz

.github/workflows/npmpublish.yml

@@ -0,0 +1,44 @@
+name: Publish Package
+
+on:
+    push:
+        branches:
+            - release
+
+jobs:
+    npm_publish:
+        if: "! contains(toJSON(github.event.commits.*.message), '[Version Bump]')"
+        name: NPM Publish
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                node-version: [20.x]
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  token: ${{ secrets.HOUZZ_CI_TOKEN }}
+
+            - name: Setup GIT
+              run: |
+                  git config user.email "[email protected]"
+                  git config user.name "houzz-ci"
+
+            - uses: actions/setup-node@v3
+              with:
+                  node-version: ${{ matrix.node-version }}
+                  registry-url: https://npm.pkg.github.com/
+                  scope: houzz
+
+            - name: Bump up patch version and push to github
+              run: |
+                  npm version patch -m "chore: [Version Bump] %s"
+                  git push "https://github.com/$GITHUB_REPOSITORY" release --no-verify
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.HOUZZ_CI_TOKEN }}
+
+            - name: Publish package to github registry
+              run: |
+                  npm publish --tag "latest" ./ > publish_message.txt
+                  echo "##[set-output name=message;]$(cat publish_message.txt)"
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.HOUZZ_CI_TOKEN }}

README.md

@@ -1,7 +1,37 @@
 # eslint-config-ivy
 
+> ⚠️ **CAUTION**  
+> We now have a published package available on npm! However, for backward compatibility, we need to maintain two branches for now:
+>
+> -   **`master`**: For legacy usage (`github:Houzz/eslint-config-ivy#master`).
+> -   **`release`**: For the new npm package (`@houzz/eslint-config-ivy`).
+>
+> Please migrate all old usages to the new package as soon as possible. The legacy branch will eventually be deprecated.
+
 ## Usage
 
+New (Recommended): Install the latest version from npm
+
+```sh
+npm install @houzz/eslint-config-ivy --save-dev
+```
+
+```json
+// .eslintrc
+{
+    "extends": ["@houzz/eslint-config-ivy"]
+}
+```
+
+Legacy (Deprecated): For temporary backward compatibility
+
 ```sh
 npm install github:Houzz/eslint-config-ivy#master
 ```
+
+```json
+// .eslintrc
+{
+    "extends": ["eslint-config-ivy"]
+}
+```

package.json

@@ -1,16 +1,19 @@
 {
-  "name": "eslint-config-ivy",
-  "version": "1.0.1",
-  "description": "Eslint configuration for ivy projects",
-  "main": "index.js",
-  "exports": {
-    ".": "./index.js",
-    "./stylelint": "./stylelint.js",
-    "./package.json": "./package.json"
-  },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "author": "",
-  "license": "ISC"
+    "name": "@houzz/eslint-config-ivy",
+    "version": "1.0.49",
+    "description": "ESlint configuration for ivy projects",
+    "main": "index.js",
+    "exports": {
+        ".": "./index.js",
+        "./stylelint": "./stylelint.js",
+        "./package.json": "./package.json"
+    },
+    "scripts": {
+        "test": "echo \"Error: no test specified\" && exit 1"
+    },
+    "publishConfig": {
+        "registry": "https://npm.pkg.github.com/Houzz"
+    },
+    "author": "",
+    "license": "ISC"
 }