@@ -71,20 +71,27 @@ Sample ``.coveralls.yml`` file::
7171Github Actions support
7272----------------------
7373
74- Coveralls natively supports jobs running on Github Actions. You can directly pass the default-provided secret GITHUB_TOKEN::
74+ Coveralls natively supports jobs running on Github Actions. You can directly
75+ pass the default-provided secret GITHUB_TOKEN::
7576
7677 env:
7778 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
7879 run: |
79- coveralls
80+ coveralls --service=github
8081
8182Passing a coveralls.io token via the ``COVERALLS_REPO_TOKEN `` environment variable
8283(or via the ``repo_token `` parameter in the config file) is not needed for
8384Github Actions.
8485
85- Sometimes Github Actions gets a little picky about the service name which needs to
86- be used in various cases. If you run into issues, try setting the ``COVERALLS_SERVICE_NAME ``
87- explicitly to either ``github `` or ``github-actions ``.
86+ Sometimes Github Actions gets a little picky about the service name which needs
87+ to be used in various cases. If you run into issues, try setting the
88+ ``COVERALLS_SERVICE_NAME `` explicitly to either ``github `` or
89+ ``github-actions ``. It seems to be the case that you should use the
90+ ``--service=github `` value if you are also planning to use the ``GITHUB_TOKEN ``
91+ env var, and ``github-actions `` (which is the default) in any other case, but
92+ we've have conflicting reports on this: YMMV! See
93+ `#452 <https://github.com/TheKevJames/coveralls-python/issues/252 >`_ for more
94+ info.
8895
8996For parallel builds, you have to add a final step to let coveralls.io know the
9097parallel build is finished::
@@ -103,7 +110,7 @@ parallel build is finished::
103110 - name: Test
104111 run: ./run_tests.sh ${{ matrix.test-name }}
105112 - name: Upload coverage data to coveralls.io
106- run: coveralls
113+ run: coveralls --service=github
107114 env:
108115 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
109116 COVERALLS_FLAG_NAME: ${{ matrix.test-name }}
@@ -117,7 +124,7 @@ parallel build is finished::
117124 - name: Finished
118125 run: |
119126 pip3 install --upgrade coveralls
120- coveralls --finish
127+ coveralls --service=github -- finish
121128 env:
122129 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
123130
0 commit comments