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

Change README.md CI badges to use GitHub actions #3501

Merged
merged 6 commits into from
Jan 12, 2024

Conversation

AhdraMeraliQB
Copy link
Contributor

@AhdraMeraliQB AhdraMeraliQB commented Jan 12, 2024

Description

Addresses #3223

The good news: GitHub has a lot of documentation for adding and customising badges
The bad news: There isn't (yet) a way to customise the text on the badge xref. Currently using the same third party customiser that we used for the CircleCI badges.

The badges check the all-checks.yml GH Actions workflow for branches main and develop, respectively (GH Actions badges are workflow specific).

Development notes

Link to the README with new badges

Developer Certificate of Origin

We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a Signed-off-by line in the commit message. See our wiki for guidance.

If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.

Checklist

  • Read the contributing guidelines
  • Signed off each commit with a Developer Certificate of Origin (DCO)
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the RELEASE.md file
  • Added tests to cover my changes
  • Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

@ankatiyar
Copy link
Contributor

I think shields.io also has badges for Github Actions - https://shields.io/badges/git-hub-actions-workflow-status you can try that.
Also, there's badges on the docs front page as well which can be changed!

@AhdraMeraliQB
Copy link
Contributor Author

AhdraMeraliQB commented Jan 12, 2024

I think shields.io also has badges for Github Actions - https://shields.io/badges/git-hub-actions-workflow-status you can try that. Also, there's badges on the docs front page as well which can be changed!

Noticed the shields.io badges, added them in c7e0b21, and good spot for the docs!

Signed-off-by: Ahdra Merali <[email protected]>
docs/source/index.rst Outdated Show resolved Hide resolved
@stichbury
Copy link
Contributor

Checked on the docs build https://kedro--3501.org.readthedocs.build/en/3501/ and all looks good to me (the links work fine). Thank you!

Ahdra Merali added 2 commits January 12, 2024 11:08
Signed-off-by: Ahdra Merali <[email protected]>
Copy link
Contributor

@ankatiyar ankatiyar left a comment

Choose a reason for hiding this comment

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

Looks good to me! ⭐

@AhdraMeraliQB AhdraMeraliQB enabled auto-merge (squash) January 12, 2024 11:46
@AhdraMeraliQB AhdraMeraliQB merged commit d433ff3 into main Jan 12, 2024
11 checks passed
@AhdraMeraliQB AhdraMeraliQB deleted the ci/add-gh-actions-badge-to-readme branch January 12, 2024 11:50
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.

Update status badges in docs to check GA instead of CCI
3 participants