chore(release): v1.0.1

.github/workflows/send-relevant-notifications-action.yml

@@ -1,4 +1,4 @@
-name: Send Relevant comment
+name: Send Relevant Comment
 on:
   pull_request:
     types: [closed]
@@ -13,8 +13,8 @@ jobs:
     timeout-minutes: 15
     runs-on: ubuntu-latest
     steps:
-      - name: checkout code repository
-        uses: vegetables-school/send-relevant-comment-action@v0.0.20
+      - name: send relevant comment
+        uses: vegetables-school/send-relevant-comment-action@v1
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
-          custom-comment: 'Hello, this is a custom comment'
+          custom-comment: 'Hello, This is the trigger comment'

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 
 
+## v1.0.1
+
+[compare changes](https://github.com/vegetables-school/send-relevant-comment-action/compare/v0.0.20...v1.0.1)
+
 ## v0.0.20
 
 [compare changes](https://github.com/vegetables-school/send-relevant-comment-action/compare/v0.0.19...v0.0.20)

README.md

@@ -1,6 +1,32 @@
 # send-relevant-comment-action
 
-test
+It is used to collect links in pr or issues that contain other links that exist on github.
 
-> [!WARNING]
-> This project is still under development. There will be significant changes.
+![alt text](./asset/image.png)
+
+## Usage
+
+Can be used in the following scenarios (but not just this one)
+
+```yml
+name: Send Relevant Comment
+on:
+  pull_request:
+    types: [closed]
+
+permissions:
+  pull-requests: write
+  issues: write
+
+jobs:
+  version:
+    # if: github.event.pull_request.merged == true
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+    steps:
+      - name: send relevant comment
+        uses: vegetables-school/send-relevant-comment-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          custom-comment: 'Hello, this is a custom comment'
+```

package.json

@@ -2,7 +2,7 @@
   "name": "@vegetables-school/send-relevant-comment-action",
   "description": "Send comment of relevant issues and PR within the PR",
   "license": "MIT",
-  "version": "0.0.20",
+  "version": "1.0.1",
   "author": "vegetables-school",
   "private": true,
   "homepage": "https://github.com/vegetables-school/send-relevant-comment-action",

src/index.ts

@@ -16,11 +16,9 @@ export async function run(): Promise<void> {
     const context = github.context
 
     const getCustomCommentInput = core.getInput('custom-comment')
-    core.info(`getCustomCommentInput: ${getCustomCommentInput}`)
     const customCommentBody =
       getCustomCommentInput ||
       `This is a comment related to #${context.issue.number}`
-    core.info(`customCommentBody: ${customCommentBody}`)
 
     const prRelateArr = await getPrRelate(octokit, context)