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

doc: Add status icon for CI pipelines #2177

Closed
wants to merge 1 commit into from

Conversation

theComputeKid
Copy link
Contributor

@theComputeKid theComputeKid commented Oct 21, 2024

It can be beneficial for users to know whether to expect the main branch to build as expected, especially for AArch64, as our current way of pushing directly to main can break AArch64 CI. Users can look to see the current CI status in the latest git commit, but for better visibility, we can add a badge. This also gives us the status of the last full CI run instead of the current CI run that the git commit status will give us (which may not be complete at the time of viewing, and can hide the current CI status). Also recall that AArch64 CI does not fully complete on forks and so they will never show the correct CI status on the git commits, and instead will need to rely on the badge.

We added status badges in the README here: 4d82471

This change adds another badge for CI. An example view of badge can be seen from my fork's README: https://github.com/theComputeKid/oneDNN/tree/badges

I don't have the privileges to get the x86 CI badges from Azure, so will wait for @vpirogov or @mgouicem, in case they want to add x86 badges.

@theComputeKid theComputeKid requested review from a team as code owners October 21, 2024 13:48
@github-actions github-actions bot added the documentation A request to change/fix/improve the documentation. Codeowner: @oneapi-src/onednn-doc label Oct 21, 2024
Copy link
Contributor

@ranukund ranukund left a comment

Choose a reason for hiding this comment

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

Looks good!

@vpirogov
Copy link
Contributor

The issue I have with CI badges is that they show current status for the main development branch, but once added to README.md the same badges will be displayed for release branches and in forks, which is misleading. OpenSSF badges are focused on project practices, which are not as transient as build health.

Also Azure badge is horrible :(

Build Status

@theComputeKid
Copy link
Contributor Author

Can we can label them to indicate that they are for main? I was thinking more from the perspective of showing off github aarch64 runners. Is there any way we can make it work? Otherwise, no issue, we can drop it.

@vpirogov
Copy link
Contributor

I'd suggest we find a place outside of the code tree to host CI status. We can stick these into Github wiki for example. Will that work?

@vpirogov
Copy link
Contributor

How does this look?

@theComputeKid
Copy link
Contributor Author

@vpirogov it looks good, we can do that.

btw, the aarch64 pipelines will never be successful on forks because only oneDNN + PRs have access to aarch64 runners.

@vpirogov
Copy link
Contributor

CI status badges for main and rls-v3.6 branches are now available in wiki.

@vpirogov vpirogov closed this Oct 30, 2024
@theComputeKid theComputeKid deleted the badges branch December 30, 2024 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation A request to change/fix/improve the documentation. Codeowner: @oneapi-src/onednn-doc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants