fix: do not add comments when PR from fork (#100)

* build: fixed errors when PR from fork and updated dependencies

* build: just testing the comment from a fork

* fix: just adding some comment to test adding comment from a fork

* fix: log info in PR to run some tests

* fix: more tests

* fix: and more tests

* fix: test fork and add comments

* fix: removed comments and added tests

Author: belitre

.github/workflows/pull_request.yml

@@ -22,4 +22,4 @@ jobs:
         uses: ./
         with:
           addHoldComment: "true"
-          status: "${{ job.status }}"
+          status: "${{ job.status }}"

Makefile

@@ -41,7 +41,7 @@ semantic-release-dry-run:
 install-npm-check-updates:
 	npm install npm-check-updates
 
-.PHONY: update-denendencies
-update-denendencies: install-npm-check-updates
+.PHONY: update-dependencies
+update-dependencies: install-npm-check-updates
 	ncu -u
 	npm install

README.md

@@ -48,7 +48,7 @@ GitHub does not update the status of a commit when running workflow and therefor
   * optional
   * default: "true" 
 
-* addHoldComment: If true the action will add a comment to the pull request. This is useful if you use prow and you get PRs from forks, you can use `/hold` and `/hold cancel` instead of the status check since the token won't have permissions to do that.
+* addHoldComment: If true the action will add a comment to the pull request. This is useful if you use prow, since prow won't detect the github actions, so you can use `/hold` and `/hold cancel` to avoid merging the PR before you want. __Important: this will be disabled for forks if `ignoreForks` is set to true, this is because the default github token won't have permissions to add comments if your PR comes from a fork__
 
   * optional
   * default: "false"
@@ -82,7 +82,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - uses: ouzi-dev/commit-status-updater@v1.0.0
+    - uses: ouzi-dev/commit-status-updater@v1.0.4
 ```
 
 ### Action sets commit to error status without comment
@@ -97,7 +97,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - uses: ouzi-dev/commit-status-updater@v1.0.0
+    - uses: ouzi-dev/commit-status-updater@v1.0.4
       with:
         status: "error"
 ```
@@ -114,11 +114,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - uses: ouzi-dev/commit-status-updater@v1.0.0
+    - uses: ouzi-dev/commit-status-updater@v1.0.4
       with:
         addHoldComment: "true"
     - if: always()
-      uses: ouzi-dev/commit-status-updater@v1.0.0
+      uses: ouzi-dev/commit-status-updater@v1.0.4
       with:
         addHoldComment: "true"
         status: "${{ job.status }}"
@@ -136,7 +136,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - uses: ouzi-dev/commit-status-updater@v1.0.0
+    - uses: ouzi-dev/commit-status-updater@v1.0.4
       with:
         status: "pending"
         addHoldComment: "true"
@@ -157,7 +157,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - uses: ouzi-dev/commit-status-updater@v1.0.0
+    - uses: ouzi-dev/commit-status-updater@v1.0.4
       with:
         status: "error"
         url: http://myurl.io/
@@ -177,7 +177,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - uses: ouzi-dev/commit-status-updater@v1.0.0
+    - uses: ouzi-dev/commit-status-updater@v1.0.4
       with:
         token: "my_custom_token"
         ignoreForks: "false"

__test__/runner.test.ts

@@ -86,6 +86,23 @@ describe('runner tests', () => {
     expect(mockIGithubHelper.addComment).toHaveBeenCalledTimes(0)
   })
 
+  it('run does not set status or comment when it is a fork and add comment enabled', async () => {
+    const params = ({} as unknown) as IParams
+    params.token = 'bleh'
+    params.ignoreForks = true
+    params.addHoldComment = true
+    params.selectedComment = 'my comment'
+    mockInputsHelper.getInputs.mockReturnValue(params)
+    mockGithubHelper.CreateGithubHelper.mockReturnValue(mockIGithubHelper)
+    mockIGithubHelper.isFork.mockReturnValue(true)
+
+    await runner.run()
+
+    expect(mockUtils.validateEventType).toHaveBeenCalled()
+    expect(mockIGithubHelper.setStatus).toHaveBeenCalledTimes(0)
+    expect(mockIGithubHelper.addComment).toHaveBeenCalledTimes(0)
+  })
+
   it('run sets status if ignore fork false', async () => {
     const params = ({} as unknown) as IParams
     params.token = 'bleh'

dist/index.js

@@ -1445,9 +1445,11 @@ function run() {
             }
             else {
                 yield ghHelper.setStatus(params);
-            }
-            if (params.addHoldComment) {
-                yield ghHelper.addComment(params.selectedComment);
+                // for now only add comments if it's not a fork or we explicitly say don't ignore forks
+                // we should have a token with permissions in the fork for this
+                if (params.addHoldComment) {
+                    yield ghHelper.addComment(params.selectedComment);
+                }
             }
         }
         catch (error) {
@@ -3555,9 +3557,9 @@ module.exports = safer
 /***/ }),
 
 /***/ 256:
-/***/ (function() {
+/***/ (function(module) {
 
-eval("require")("iconv");
+module.exports = eval("require")("iconv");
 
 
 /***/ }),
@@ -28427,10 +28429,13 @@ class GithubHelper {
     }
     addComment(comment) {
         return __awaiter(this, void 0, void 0, function* () {
+            // if we support forks, then we need to use the base, cause head will be the fork
+            const baseOwner = this.payload.pull_request.base.repo.owner.login;
+            const baseRepo = this.payload.pull_request.base.repo.name;
             try {
                 yield this.octokit.issues.createComment({
-                    owner: this.owner,
-                    repo: this.repo,
+                    owner: baseOwner,
+                    repo: baseRepo,
                     issue_number: this.issueNumber,
                     body: comment
                 });