Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding tests badge to the repository README #10

Merged
merged 1 commit into from
Sep 29, 2023
Merged

adding tests badge to the repository README #10

merged 1 commit into from
Sep 29, 2023

Conversation

miki725
Copy link
Contributor

@miki725 miki725 commented Sep 29, 2023

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.

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.
@miki725 miki725 requested a review from viega as a code owner September 29, 2023 16:18
@miki725
Copy link
Contributor Author

miki725 commented Sep 29, 2023

this is how it shows up:

image

Copy link
Contributor

@viega viega left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@miki725 miki725 merged commit 5be5c3c into main Sep 29, 2023
@miki725 miki725 deleted the badge branch September 29, 2023 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants