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

README.md: Update Azure Pipelines status badges #4085

Merged
merged 2 commits into from
Oct 14, 2023

Conversation

StephanTLavavej
Copy link
Member

@StephanTLavavej StephanTLavavej commented Oct 12, 2023

This adds a status badge for the daily ASAN CI that @CaseyCarter finished implementing with #4069. It also updates our existing badge.

  • The existing badge image was still mentioning microsoft.STL, so I suspect that the image was stale, i.e. it would appear green even if the newly renamed STL-CI was failing.
  • I've generated/regenerated the badges and then further edited their Markdown. The way is to look at the pipeline, e.g. https://dev.azure.com/vclibs/STL/_build?definitionId=4&_a=summary , click on the vertical ellipsis at the upper right, click "Status badge", set the Branch to main, and then look at the Sample Markdown.
  • It helps to be familiar with GitHub Flavored Markdown's image syntax: https://github.github.com/gfm/#images
  • As suggested by @CaseyCarter, I'm using "CI Status Badge" and "ASan CI Status Badge" as the alt text (for accessibility).
  • I'm extracting both the badge URL (for the image) and the link (for clicking on it) in reference style, making it easier to visually read the Markdown, and avoiding column length limitations.
  • I'm saying "(STL-CI build status)" and "(STL-ASan-CI build status)" to explain why we have two badges. They appear at the end so that the badges are aligned on the left.
  • For the reference links, I'm abandoning any attempt to keep them sorted (we had already accumulated non-sorted links).
  • These links are freshly generated - the generator now emits %2F instead of /, in addition to fixing the previously mentioned microsoft.STL staleness.
  • The quoted "STL-CI" and "STL-ASan-CI" at the end of the badge URLs produces title text that's displayed on hover. I thought it was nice to have these be distinct, even though the ordinary text in the bullet points is right there. I suppose we could drop these titles, though (we didn't have them before).

✅ ✅ Live preview: https://github.com/StephanTLavavej/STL/tree/asan-badge#microsofts-c-standard-library

@StephanTLavavej StephanTLavavej added the documentation Related to documentation or comments label Oct 12, 2023
@StephanTLavavej StephanTLavavej requested a review from a team as a code owner October 12, 2023 00:48
README.md Outdated Show resolved Hide resolved
Co-authored-by: Casey Carter <cacarter@microsoft.com>
@CaseyCarter CaseyCarter removed their assignment Oct 13, 2023
@StephanTLavavej StephanTLavavej self-assigned this Oct 13, 2023
@StephanTLavavej
Copy link
Member Author

I'm mirroring this to the MSVC-internal repo - please notify me if any further changes are pushed.

@StephanTLavavej StephanTLavavej merged commit 1c59a20 into microsoft:main Oct 14, 2023
@StephanTLavavej StephanTLavavej deleted the asan-badge branch October 14, 2023 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Related to documentation or comments
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants