Investigate Coveralls failure about "parallel builds"

[surchs]

This issue has recently crept up in this repo (so far only):

Coveralls fails on the Python 3.10 runner (so far I have only seen it on that version) with the following error:

Can't add a job to a build that is already closed. Build 6829765660 is closed. See docs.coveralls.io/parallel-builds

See e.g. here

The docs in question: docs.coveralls.io/parallel-builds

We should investigate why this happens and if it is on our side or their side

[surchs]

Just rerunning the failed test does not seem to help. But simply pushing an empty or almost empty commit to the PR branch appears to reliably resolve the error. See e.g. #237

@alyssadai was this also your experience?

[alyssadai]

Yep. I also found lemurheavy/coveralls-public#1716, which seems relevant but I was discouraged by the long thread and so have not yet read it in detail 🙈

[surchs]

also see: neurobagel/planning#89

[alyssadai]

Note: this is only happening in the bagel-cli repo, whose test workflow is currently configured differently from our other python tools (api, federation-api) in that the triggers are:

on: [push, pull_request]

instead of

on:
  push:
    branches:
      - main
  pull_request:
  workflow_dispatch:

as well, the bagel-cli is currently the only one that tests two python versions (3.9, 3.10).

Either or both of these could be causing problems for Coveralls.

It's worth noting that the codecov blog post on Python code coverage https://about.codecov.io/blog/python-code-coverage-using-github-actions-and-codecov/ provides an example of a workflow yml that also uses on: [push. pull_request] which we're currently using for the CLI - so maybe our current hooks aren't necessarily the problem?

From a quick search in the codecov repos, this closed issue also seems potentially relevant: codecov/codecov-action#40

All in all, it might not be a bad idea to try switching to codecov for the CLI to see if we can replicate this problem. For now, the other repos don't seem affected.