Test badge

[alan-barzilay]

update status badge from travis to github action and Break tests and codecov workflow in 2.

The idea is to have the status badge report if the tests are passing,
without considering codecov since it frequently fails due to some
network hickup that makes the report upload to fail.

This also makes things a bit more compartimentalized.

[alan-barzilay]

relevant reference: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_run

Also:

Note: This event will only trigger a workflow run if the workflow file is on the default branch.

[alan-barzilay]

it will go from this:

to this:

[alan-barzilay]

tested on https://github.com/pipreqsxp/pipreqs/actions/runs/6800189760/job/18488179557 and tests work as expected once they reach the main branch, with codecov being called after a successful run of "Tests".

(The code coverage test is expected to fail since that repo doesnt have the codecov token to perform the upload)

[alan-barzilay]

I set the tracking to tests performed on the master branch, a broken test in the next branch or in a random PR doesnt seem to be very informative or relevant to users since unless they manually instal pipreqs they will get the master branch through pypi

[willianrocha]

If the pipeline fails, will the badge reflect update the status?

[alan-barzilay]

if the pipeline fails (aka any of the tests fail) the coverage_report workflow won't be run and if the branch being tested happens to be the master branch, then the badge will be updated as failing

[alan-barzilay]

Would you consider adding a report here? like it is done in Code Coverage Report using insightsengineering/coverage-action@v2. It would be nice to see the status during the PR progress.

That would be nice but sadly we run into a problem of not having permission for the bot to do its thing. In the interest of time I will drop this idea for now and create an issue to register our interest for the future.

Here is the step I tried to implement into the workflow:

            - name: Produce the coverage report
              uses: insightsengineering/coverage-action@v2
              with:
		path: coverage.xml
		# Publish the rendered output as a PR comment
		publish: true
		# Create a coverage diff report.
		diff: true
		# Branch to diff against.
		diff-branch: next
		# This is where the coverage reports for the
		# `diff-branch` are stored.
		diff-storage: _xml_coverage_reports
		togglable-report: true

[alan-barzilay]

there seems to be an issue, the codecov test is run but doesnt show up in the PR, it seems to loose any association with what trigerred it