Use GITHUB_TOKEN on webhook

Providing the `repo_name` parameter on webhook makes it possible to also
use `GITHUB_TOKEN` for the `repo_token` parameter.

Author: AndreMiras

.github/workflows/push.yml

@@ -42,6 +42,5 @@ jobs:
     - name: Coveralls Finished
       uses: ./
       with:
-        github-token: ${{ secrets.COVERALLS_REPO_TOKEN }}
         parallel-finished: true
         debug: true

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## [Unrelease]
+
+  - Made `github-token` parameter optional
+
+
 ## [v20200412]
 
   - Leverages `with` keyword to configure the action

README.md

@@ -40,7 +40,6 @@ jobs:
        uses: AndreMiras/coveralls-python-action@develop
        with:
          parallel-finished: true
-         github-token: ${{ secrets.COVERALLS_REPO_TOKEN }}
 ```
 
 ## Configuration
@@ -54,7 +53,6 @@ jobs:
     # Default: false
     parallel: ''
     # Set to `true` for the last action when using `parallel: true`.
-    # Note this phase requires `github-token: ${{ secrets.COVERALLS_REPO_TOKEN }}`.
     # Default: false
     parallel-finished: ''
     # Set to true to increase logger verbosity.

src/entrypoint.py

@@ -79,6 +79,11 @@ def get_github_ref():
     return os.environ.get("GITHUB_REF")
 
 
+def get_github_repository():
+    """e.g. octocat/Hello-World"""
+    return os.environ.get("GITHUB_REPOSITORY")
+
+
 def get_pull_request_number(github_ref):
     """
     >>> get_pull_request_number("refs/pull/<pull_request_number>/merge")
@@ -101,16 +106,20 @@ def get_build_number(github_sha, github_ref):
 
 def post_webhook(repo_token):
     """"
-    Note for this call, the repo token is always `COVERALLS_REPO_TOKEN`.
-    It cannot be the `GITHUB_TOKEN`.
     https://docs.coveralls.io/parallel-build-webhook
     """
     url = "https://coveralls.io/webhook"
     build_num = get_build_number(get_github_sha(), get_github_ref())
-    params = {"repo_token": repo_token}
-    json = {"payload": {"build_num": build_num, "status": "done"}}
-    log.debug(f'requests.post("{url}", params={params}, json={json})')
-    response = requests.post(url, params=params, json=json)
+    # note this (undocumented) parameter is optional, but needed for using
+    # `GITHUB_TOKEN` rather than `COVERALLS_REPO_TOKEN`
+    repo_name = get_github_repository()
+    json = {
+        "repo_token": repo_token,
+        "repo_name": repo_name,
+        "payload": {"build_num": build_num, "status": "done"},
+    }
+    log.debug(f'requests.post("{url}", json={json})')
+    response = requests.post(url, json=json)
     response.raise_for_status()
     log.debug(f"response.json(): {response.json()}")
     assert response.json() == {"done": True}, response.json()

tests/test_entrypoint.py

@@ -158,8 +158,11 @@ def test_post_webhook(self):
         assert m_post.call_args_list == [
             mock.call(
                 "https://coveralls.io/webhook",
-                params={"repo_token": "TOKEN"},
-                json={"payload": {"build_num": None, "status": "done"}},
+                json={
+                    "repo_token": "TOKEN",
+                    "repo_name": None,
+                    "payload": {"build_num": None, "status": "done"},
+                },
             )
         ]
         # 2) only `GITHUB_SHA` is set
@@ -171,12 +174,13 @@ def test_post_webhook(self):
         assert m_post.call_args_list == [
             mock.call(
                 "https://coveralls.io/webhook",
-                params={"repo_token": "TOKEN"},
                 json={
+                    "repo_token": "TOKEN",
+                    "repo_name": None,
                     "payload": {
                         "build_num": "ffac537e6cbbf934b08745a378932722df287a53",
                         "status": "done",
-                    }
+                    },
                 },
             )
         ]
@@ -190,31 +194,34 @@ def test_post_webhook(self):
         assert m_post.call_args_list == [
             mock.call(
                 "https://coveralls.io/webhook",
-                params={"repo_token": "TOKEN"},
                 json={
+                    "repo_token": "TOKEN",
+                    "repo_name": None,
                     "payload": {
                         "build_num": "ffac537e6cbbf934b08745a378932722df287a53",
                         "status": "done",
-                    }
+                    },
                 },
             )
         ]
         # 4) `GITHUB_REF` is a pull request
         environ = {
             "GITHUB_SHA": "ffac537e6cbbf934b08745a378932722df287a53",
             "GITHUB_REF": "refs/pull/123/merge",
+            "GITHUB_REPOSITORY": "octocat/Hello-World",
         }
         with patch_requests_post(json_response) as m_post, patch_os_envirion(environ):
             entrypoint.post_webhook(repo_token)
         assert m_post.call_args_list == [
             mock.call(
                 "https://coveralls.io/webhook",
-                params={"repo_token": "TOKEN"},
                 json={
+                    "repo_token": "TOKEN",
+                    "repo_name": "octocat/Hello-World",
                     "payload": {
                         "build_num": "ffac537e6cbbf934b08745a378932722df287a53-PR-123",
                         "status": "done",
-                    }
+                    },
                 },
             )
         ]
@@ -232,8 +239,11 @@ def test_post_webhook_error(self):
         assert m_post.call_args_list == [
             mock.call(
                 "https://coveralls.io/webhook",
-                params={"repo_token": "TOKEN"},
-                json={"payload": {"build_num": None, "status": "done"}},
+                json={
+                    "repo_token": "TOKEN",
+                    "repo_name": None,
+                    "payload": {"build_num": None, "status": "done"},
+                },
             )
         ]
         assert ex_info.value.args == (json_response,)