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

[docs][README] Update badges #388

Merged
merged 4 commits into from
Jan 9, 2021
Merged

[docs][README] Update badges #388

merged 4 commits into from
Jan 9, 2021

Conversation

jidicula
Copy link
Member

@jidicula jidicula commented Jan 9, 2021

Why this change was necessary
Dependency installation checks were added in #387. These Actions
should be pointed to by the README badges until we have workflows
actually testing the application build (#268 and others).

What this change does
Updates badges to point to the dependency installation workflows.

Any side-effects?
None

Additional context/notes/links

**Why this change was necessary**
Dependency installation checks were added in #387. These Actions
should be pointed to by the README badges until we have workflows
actually testing the application build (#268 and others).

**What this change does**
Updates badges to point to the dependency installation workflows.

**Any side-effects?**
None

**Additional context/notes/links**
 - List of open issues mentioning testing: https://github.com/idoneam/Canary/issues?q=is%3Aissue+is%3Aopen+test
Copy link
Contributor

@le-potate le-potate left a comment

Choose a reason for hiding this comment

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

Poetry Production Dependency Installation and the other is maybe a bit too long, it gets cut on my screen

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
le-potate
le-potate previously approved these changes Jan 9, 2021
Copy link
Contributor

@le-potate le-potate left a comment

Choose a reason for hiding this comment

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

Note that this didn't change the long name that appears on the README, I think that's linked to what it's named in the poetry-dev.yml and poetry-prod.yml files. Feel free to either change this or merge anyways

jidicula added a commit that referenced this pull request Jan 9, 2021
A badge title is defined by the corresponding workflow's `name`
attribute.

Resolves #388 (review)
@le-potate
Copy link
Contributor

le-potate commented Jan 9, 2021

I think you also need to update the urls now that the names have changed

A badge title is defined by the corresponding workflow's `name`
attribute.

Resolves #388 (review)
@jidicula
Copy link
Member Author

jidicula commented Jan 9, 2021

I think you also need to update the urls now that the names have changed

Good catch. I've updated the urls and the titles again. The dev badge will only update upon merge (since it points to dev), and the prod badge will only update when we merge to master.

Copy link
Contributor

@le-potate le-potate left a comment

Choose a reason for hiding this comment

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

lgtm

@jidicula jidicula merged commit b1789cc into dev Jan 9, 2021
@jidicula jidicula deleted the fix-badges branch January 9, 2021 21:13
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.

2 participants