Skip to content

docs(readme): add ci status badge #509

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

Merged
merged 1 commit into from
Apr 26, 2020
Merged

Conversation

fundon
Copy link
Contributor

@fundon fundon commented Nov 11, 2019

No description provided.

@ghost ghost requested a review from yoshuawuyts November 12, 2019 01:41
@@ -8,6 +8,11 @@
<br />

<div align="center">
<!-- CI status -->
<a href="https://github.com/async-rs/async-std/actions">
<img src="https://github.com/async-rs/async-std/workflows/CI/badge.svg"
Copy link

Choose a reason for hiding this comment

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

It would be nice if we could choose ?style=flat-square here but I don't think GitHub's badges have configurable style. Maybe I'm wrong though.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Currently, GitHub cant customize style. Maybe wait badges/shields#2574.

@taiki-e
Copy link
Contributor

taiki-e commented Nov 12, 2019

Which branch's status is pointed?
As we are not running CI on the master branch, if this is reporting the status of master, the status is pointing to the old commit.
On the other hand, if it points to another branch, the status may be from a PR that has not landed.

(I confirmed the above behavior, I removed the GitHub actions badge from all my projects about a month ago, but it may have changed now)

@fundon
Copy link
Contributor Author

fundon commented Nov 12, 2019

@taiki-e
Copy link
Contributor

taiki-e commented Nov 13, 2019

@fundon Thanks, I'll look that.

@taiki-e
Copy link
Contributor

taiki-e commented Nov 13, 2019

Docs says:

By default, badges display the status of your default branch (usually master).

As we are not running CI on the master branch, the status of one month ago is currently displayed.
So, to activate the badge I think we need a branch where CI is always run (i.e., need to enable CI on master).

@dignifiedquire dignifiedquire changed the title Add ci status badge docs(readme): add ci status badge Apr 26, 2020
@dignifiedquire dignifiedquire merged commit e707ea9 into async-rs:master Apr 26, 2020
@dignifiedquire
Copy link
Member

Thank you

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.

4 participants