adding tests badge to the repository README #10
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change adds a badge (svg image) to the repo README which shows the status of the tests CI pipeline.
Hopefully it will show just that tests are passing all the time 😉
The badge also links to the github action page which shows the history of the tests running on main branch. Speaking of the main branch, the badge only shows
tests status for the main branch so that if any tests fail on any PRs, they will not impact the badge status.
Finally this change only runs tests on merges to main only when any of the source code changes so that we dont run tests for things like documentation changes.