Skip to content

Add skip_all option for checks and check collections - #28

Merged
rmm5t merged 3 commits into
mainfrom
rmm/skip-all-option
Sep 10, 2026
Merged

Add skip_all option for checks and check collections#28
rmm5t merged 3 commits into
mainfrom
rmm/skip-all-option

Conversation

@rmm5t

@rmm5t rmm5t commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a skip_all: true registration option for checks that should remain directly accessible without running as part of /okcomputer/all.

This also enables independently addressable groups of checks:

versions = OkComputer::CheckCollection.new("Versions")

OkComputer::Registry.register "versions", versions, skip_all: true
OkComputer::Registry.register "ruby_version", OkComputer::RubyVersionCheck.new, "versions"
OkComputer::Registry.register "app_version", OkComputer::AppVersionCheck.new, "versions"

The version checks are available through /okcomputer/versions and their individual endpoints, but are omitted from /okcomputer/all.

Implementation

  • Adds a skip_all attribute to checks and check collections.
  • Configures the default collection to omit entries marked skip_all.
  • Keeps skipped entries available through registry lookup.
  • Preserves normal behavior for named collections.
  • Supports excluding individual checks as well as entire collections.
  • Documents grouped checks and the new registration option.

Testing

  • Added coverage for execution, lookup, text output, JSON output, and success status.
  • Added coverage for skipped individual checks and collections.
  • Full suite passes with 461 examples, 0 failures.

/cc @dgarwood

@rmm5t rmm5t self-assigned this Sep 8, 2026
@rmm5t
rmm5t requested a review from emmahsax September 8, 2026 19:30
Comment thread spec/ok_computer/check_collection_spec.rb
@rmm5t
rmm5t force-pushed the rmm/skip-all-option branch from db9278f to a5d5102 Compare September 8, 2026 21:07
Comment thread lib/ok_computer/registry.rb Outdated

@emmahsax emmahsax left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I can make a new release too after this is merged.

@rmm5t
rmm5t merged commit f81ae2a into main Sep 10, 2026
70 checks passed
@rmm5t
rmm5t deleted the rmm/skip-all-option branch September 10, 2026 16:04
@rmm5t

rmm5t commented Sep 10, 2026

Copy link
Copy Markdown
Contributor Author

I can make a new release too after this is merged.

Thank you!

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.

3 participants