Merge pull request #36 from KID-joker/main

release 1.3.0

.github/workflows/automated-release.yaml

@@ -0,0 +1,52 @@
+name: Automated Release
+
+permissions:
+  id-token: write
+  contents: write
+
+on:
+  push:
+    branches:
+      - release
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9.15.0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+          registry-url: https://registry.npmjs.org/
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Build the project
+        run: pnpm run build
+
+      - name: Publish to npm
+        run: pnpm publish -r --access public --publish-branch release
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NPM_CONFIG_PROVENANCE: true
+
+      - name: Get version from package.json
+        id: get_version
+        run: |
+          VERSION=$(node -p "require('./package.json').version")
+          echo "VERSION=$VERSION" >> $GITHUB_ENV
+
+      - name: Create Git Tag
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git tag -a "v${VERSION}" -m "Release v${VERSION}"
+          git push https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/KID-joker/npm-deprecated-check.git "v${VERSION}"

README.md

@@ -36,13 +36,40 @@ Commands:
   help [command]                   display help for command
 ```
 
-For `OpenAI` config:
+`OpenAI` config:
 
 ```bash
 Options:
-  --openaiKey <value>      recommend alternative packages via ChatGPT
-  --openaiModel <value>    ChatGPT model (choices: "gpt-3.5-turbo", "gpt-4", "gpt-4-turbo", "gpt-4o-mini", "gpt-4o")
-  --openaiBaseURL <value>  override the default base URL for the API
+  --openaiKey <value>       recommend alternative packages via ChatGPT
+  --openaiModel <value>     ChatGPT model (choices: "gpt-3.5-turbo", "gpt-4", "gpt-4-turbo", "gpt-4o-mini", "gpt-4o")
+  --openaiBaseURL <value>   override the default base URL for the API
+```
+
+For `current`:
+
+```bash
+Options:
+  --registry <value>        specify registry URL, default: https://registry.npmjs.org/
+  --ignore <value>          ignore specific packages, example: request,tslint
+  --failfast                exit the program if it has been deprecated
+```
+
+For `global`:
+
+```bash
+Options:
+  -m, --manager <value>      check specified package manager (choices: "npm", "yarn", "pnpm")
+  --registry <value>        specify registry URL, default: https://registry.npmjs.org/
+  --ignore <value>          ignore specific packages, example: request,tslint
+  --failfast                exit the program if it has been deprecated
+```
+
+For `package`:
+
+```bash
+  -r, --range <value>       check specified versions
+  --registry <value>        specify registry URL, default: https://registry.npmjs.org/
+  --failfast                exit the program if it has been deprecated
 ```
 
 You can also save them to global configuration:

package.json

@@ -1,7 +1,7 @@
 {
   "name": "npm-deprecated-check",
   "type": "module",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Check for deprecated packages",
   "author": "KID-joker <[email protected]>",
   "license": "MIT",
@@ -37,7 +37,6 @@
     "dev": "tsx ./src/cli.ts",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
-    "release": "pnpm build && bumpp && pnpm publish --no-git-checks",
     "test": "node --test",
     "typecheck": "tsc --noEmit"
   },
@@ -58,7 +57,6 @@
     "@types/node": "^22.10.1",
     "@types/semver": "^7.5.8",
     "@types/yarnpkg__lockfile": "^1.1.9",
-    "bumpp": "^9.8.1",
     "eslint": "^9.16.0",
     "lint-staged": "^15.2.10",
     "simple-git-hooks": "^2.11.1",