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

Add Health Check category group #764

Merged
merged 5 commits into from
Jan 19, 2024

Conversation

andrepiske
Copy link
Contributor

@andrepiske andrepiske commented May 4, 2023

Adds the Health Check category group with a non-extensive list of projects. Addresses rubytoolbox/rubytoolbox#1090

The goal is to list gems that provide some form of web/API endpoint(s) that perform health check (or liveness/readiness checks) by a third party. This is not about gems that call those endpoints.

Before submitting your pull request:

  • If you're referencing a gem by its GitHub repository (e.g. rails/rails), please verify
    that it is not packaged as a Ruby gem. (If it is packaged as a gem, please reference it
    by its gem name instead, e.g. rails.)
  • Please make sure the projects are listed in case-insensitive alphabetical order
  • Make sure the CI build passes, we validate your proposed changes in the test suite :)

Copy link
Member

@colszowka colszowka left a comment

Choose a reason for hiding this comment

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

Thanks for contributing @andrepiske, please check out the 2 comments I have left, other than that good to go 👍

@@ -0,0 +1,12 @@
name: Health Check
description:
projects:
Copy link
Member

Choose a reason for hiding this comment

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

This indentation is wrong and needs to be top level, this currently makes the build fail

@@ -0,0 +1,12 @@
name: Health Check
Copy link
Member

Choose a reason for hiding this comment

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

We should go with plural "Health Checks" here please, i.e. we have "Web App Frameworks"; "JSON Parsers" and so on, and I suppose the gems themselves might also be capable of doing multiple checks depending on the use case so plural makes sense there as well

@colszowka
Copy link
Member

When in doubt, it would also be a nice to add a brief category description while we're at it, something like

Easing the setup of uptime health checks for your applications that can be used for monitoring and deployment automation

- Fix indentation
- Add description
- Make the name in plural
@andrepiske andrepiske requested a review from colszowka September 2, 2023 12:51
@andrepiske
Copy link
Contributor Author

@colszowka hey I've made the changes you requested! Just took me a few months 🙄

@colszowka
Copy link
Member

Thanks @andrepiske, only a few months later this is now reviewed and I'm merging this, thanks for your contribution!

@colszowka colszowka merged commit 4d32dee into rubytoolbox:main Jan 19, 2024
4 checks passed
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