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: update badges #3233

Closed
casperdcl opened this issue Jan 24, 2020 · 6 comments · Fixed by #3380
Closed

readme: update badges #3233

casperdcl opened this issue Jan 24, 2020 · 6 comments · Fixed by #3380
Assignees
Labels
triage Needs to be triaged

Comments

@casperdcl
Copy link
Contributor

casperdcl commented Jan 24, 2020

@triage-new-issues triage-new-issues bot added the triage Needs to be triaged label Jan 24, 2020
@casperdcl casperdcl self-assigned this Jan 24, 2020
@efiop
Copy link
Contributor

efiop commented Jan 24, 2020

travis badge seems to be hardcoded as green/ok (vis iterative/dvc.org#918 (comment))

It is meant that way. To not scare off people by failing build. We have another badge just beside that is dynamic and reflects build status on master.

@casperdcl
Copy link
Contributor Author

casperdcl commented Jan 24, 2020

It is meant that way. To not scare off people by failing build.

I'd argue that makes the badge pointless. Also it shouldn't really ever be the case that a tagged release build fails. On the rare instance that it does, it should be fixed very quickly.

@efiop
Copy link
Contributor

efiop commented Jan 24, 2020

@casperdcl AFAIK, travis only allows badges for branches and not for the latest release or tag, hence why we have that dummy badge plus a real one for master

@dmpetrov
Copy link
Member

dmpetrov commented Feb 2, 2020

I guess, the common approach is to have prod branch and release only from this branch. So, the badge will be green 99.99%.

But it seems like a bit heavy solution. Are there any other reasons to have a separate branch? 😀

@casperdcl
Copy link
Contributor Author

casperdcl commented Feb 3, 2020

Hmm I feel like what this needs is a PR on shields.io to automatically pick up the last Travis tagged build. Or Travis CI itself could provide that badge. In the meantime I think just a badge for master should be enough. Normally master should never fail to build either since we should test things in dev branches before merging...

We can always set the description of the master badge to be "development," "edge," or similar so it doesn't look like releases are broken when master is.

@efiop
Copy link
Contributor

efiop commented Feb 3, 2020

dev branch complicates the workflow, we've considered this awhile ago. So far there is no real need in it and a badge is hardly a reason. Current dummy badge is hackish, but it serves the purpose. Hence why I don't think we should bother messing around with it for now.

casperdcl added a commit to casperdcl/dvc that referenced this issue Feb 21, 2020
Add |Choco|
Add |Brew|
Fix style for |Conda|
Add |PyPI|
Add |Packages|
Fixes iterative#3233
Related https://github.com/iterative/dvc.org/issues/904
@casperdcl casperdcl mentioned this issue Feb 21, 2020
7 tasks
efiop pushed a commit that referenced this issue Feb 27, 2020
* docs: add and update badges

Add |Choco|
Add |Brew|
Fix style for |Conda|
Add |PyPI|
Add |Packages|
Fixes #3233
Related https://github.com/iterative/dvc.org/issues/904

* docs: add badge logos

* docs: minor badge tidy

* docs: add choco install, add OS, update order
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
triage Needs to be triaged
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants