docs: add github actions gotcha docs

TheKevJames · Apr 14, 2020 · b120650 · b120650 · AndreMiras · Apr 25, 2020
1 parent 3071fbb
commit b120650
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/docs/usage/configuration.rst b/docs/usage/configuration.rst
@@ -49,3 +49,17 @@ Sample ``.coveralls.yml`` file::
     repo_token: mV2Jajb8y3c6AFlcVNagHO20fiZNkXPVy
     parallel: true
     coveralls_host: https://coveralls.aperture.com
+
+Github Actions Gotcha
+---------------------
+
+There's something weird with using Github Actions that we've not yet been able to entirely sort out -- if you find you're getting a 422 error on Github Actions which looks like this::
+
+    Could not submit coverage: 422 Client Error: Unprocessable Entity for url: https://coveralls.io/api/v1/jobs
+
+Then you may be able to solve it by ensuring your ``secret`` is named ``COVERALLS_REPO_TOKEN``; it seems like Github Actions may do Magic(tm) to some environment variables based on their name. The following config block seems to work properly::
+
+    env:
+        COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+    run: |
+        coveralls
diff --git a/docs/usage/tox.rst b/docs/usage/tox.rst
@@ -98,7 +98,7 @@ All variables:
 
 
 SemaphoreCI
--------
+-----------
 ::
 
     passenv = SEMAPHORE SEMAPHORE_BUILD_NUMBER BRANCH_NAME PULL_REQUEST_NUMBER
@@ -109,4 +109,5 @@ All variables:
 - ``SEMAPHORE_BUILD_NUMBER``
 - ``BRANCH_NAME``
 - ``PULL_REQUEST_NUMBER``
+
 .. _tox: https://tox.readthedocs.io/en/latest/