Merge pull request #83 from toshimaru/readme-for-issu-auto-author-assign

doc: README update for the issue auto-author-assign
toshimaru · Aug 1, 2022 · bb8170d · bb8170d
2 parents faeb58e + e45d640
commit bb8170d
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 14 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -5,10 +5,10 @@ updates:
     schedule:
       interval: weekly
     reviewers:
-    - toshimaru
+      - toshimaru
   - package-ecosystem: github-actions
     directory: /
     schedule:
       interval: weekly
     reviewers:
-    - toshimaru
+      - toshimaru
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -2,8 +2,9 @@ name: Auto Author Assign
 
 on: 
   pull_request_target:
-  issues:
-    types: [ opened, reopened ]
+  # Uncomment if you want to enable auto-author-assign for the issue
+  # issues:
+  #   types: [ opened, reopened ]
 
 permissions:
   issues: write

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,12 +4,12 @@ All notable changes to this project will be documented in this file. See [standa
 
 ## [1.6.0](https://github.com/toshimaru/auto-author-assign/compare/v1.5.1...v1.6.0) (2022-07-28)
 
-### [1.5.1](https://github.com/toshimaru/auto-author-assign/compare/v1.5.0...v1.5.1) (2022-07-22)
+## [1.5.1](https://github.com/toshimaru/auto-author-assign/compare/v1.5.0...v1.5.1) (2022-07-22)
 
-### [1.5.0](https://github.com/toshimaru/auto-author-assign/compare/v1.4.0...v1.5.0) (2022-03-28)
+## [1.5.0](https://github.com/toshimaru/auto-author-assign/compare/v1.4.0...v1.5.0) (2022-03-28)
 
-### [1.5.0](https://github.com/toshimaru/auto-author-assign/compare/v1.4.0...v1.5.0) (2022-03-28)
+## [1.5.0](https://github.com/toshimaru/auto-author-assign/compare/v1.4.0...v1.5.0) (2022-03-28)
 
-### [1.4.0](https://github.com/toshimaru/auto-author-assign/compare/v1.3.7...v1.4.0) (2021-10-17)
+## [1.4.0](https://github.com/toshimaru/auto-author-assign/compare/v1.3.7...v1.4.0) (2021-10-17)
 
-### [1.3.7](https://github.com/toshimaru/auto-author-assign/compare/v1.3.6...v1.3.7) (2021-08-29)
+## [1.3.7](https://github.com/toshimaru/auto-author-assign/compare/v1.3.6...v1.3.7) (2021-08-29)
diff --git a/README.md b/README.md
@@ -19,21 +19,17 @@ This action automatically assigns PR author as an assignee.
 name: Auto Author Assign
 
 on:
-  issues:
-    types: [ opened, reopened ]
   pull_request_target:
     types: [ opened, reopened ]
 
 permissions:
-  issues: write
   pull-requests: write
 
 jobs:
   assign-author:
     runs-on: ubuntu-latest
     steps:
       - uses: toshimaru/auto-author-assign@v1.6.0
-
 ```
 
 ## Use your own token
@@ -48,11 +44,32 @@ jobs:
       - uses: toshimaru/auto-author-assign
         with:
           repo-token: ${{ secrets.YOUR_TOKEN }}
-
 ```
 
 If not specified, `GITHUB_TOKEN` will be used by default.
 
+## Enable auto-author-assign for the issues
+
+An issue author can be automatically assigned as an issue assignee.
+
+- Add `issues` to the trigger
+- Add `issues: write` to the permissions
+
+```yml
+on:
+  issues:
+    types: [ opened, reopened ]
+  pull_request_target:
+    types: [ opened, reopened ]
+
+permissions:
+  issues: write
+  pull-requests: write
+
+jobs:
+  ...
+```
+
 ## Skip assigning author
 
 `auto-author-assign` action skips assigning the author when: