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

Fix CI badge link #121

Merged
merged 3 commits into from Jun 1, 2023
Merged

Fix CI badge link #121

merged 3 commits into from Jun 1, 2023

Conversation

osamingo
Copy link
Contributor

SSIA

@osamingo
Copy link
Contributor Author

@dylan-bourque If you have time, could you review my PR?

README.md Outdated
@@ -1,7 +1,7 @@
# UUID

[![License](https://img.shields.io/github/license/gofrs/uuid.svg)](https://github.com/gofrs/uuid/blob/master/LICENSE)
[![Build Status](https://travis-ci.org/gofrs/uuid.svg?branch=master)](https://travis-ci.org/gofrs/uuid)
[![Go](https://github.com/gofrs/uuid/actions/workflows/go.yml/badge.svg)](https://github.com/gofrs/uuid/actions/workflows/go.yml)
Copy link
Member

Choose a reason for hiding this comment

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

The link update is 👍 but I would probably leave the label set to "Build Status"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@dylan-bourque This label depends on the name of the GitHub Actions, so if we want it to be Build, we'll need to change name field in go.yml.

https://github.com/gofrs/uuid/blob/master/.github/workflows/go.yml#L1

Copy link
Member

Choose a reason for hiding this comment

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

The alt text for the image in the Markdown has to match the name of the workflow? That doesn't make sense and it's not called out that way in the docs anywhere that I can find.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The alt text one, that's ok, I mistook it for the label shown on the badge.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I fixed it 👍🏼

README.md Outdated
@@ -1,7 +1,7 @@
# UUID

[![License](https://img.shields.io/github/license/gofrs/uuid.svg)](https://github.com/gofrs/uuid/blob/master/LICENSE)
[![Build Status](https://travis-ci.org/gofrs/uuid.svg?branch=master)](https://travis-ci.org/gofrs/uuid)
[![Go](https://github.com/gofrs/uuid/actions/workflows/go.yml/badge.svg)](https://github.com/gofrs/uuid/actions/workflows/go.yml)
[![GoDoc](http://godoc.org/github.com/gofrs/uuid?status.svg)](http://godoc.org/github.com/gofrs/uuid)
Copy link
Member

Choose a reason for hiding this comment

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

As long as you're cleaning up this README, would you mind updating this link to point to pkg.go.dev?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK, I'll change it.

Copy link
Member

@dylan-bourque dylan-bourque left a comment

Choose a reason for hiding this comment

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

LGTM

@cameracker
Copy link
Contributor

Thank you very much for catching this mistake and fixing it @osamingo !

@cameracker cameracker merged commit dc06ab4 into gofrs:master Jun 1, 2023
2 checks passed
@osamingo osamingo deleted the edit-readme branch June 3, 2023 08:46
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.

None yet

3 participants