Skip to content

feat(cli): deprecate rules command in favor of skills#1361

Merged
stefanjudis merged 5 commits into
mainfrom
deprecate-rules-command
Jun 26, 2026
Merged

feat(cli): deprecate rules command in favor of skills#1361
stefanjudis merged 5 commits into
mainfrom
deprecate-rules-command

Conversation

@stefanjudis

@stefanjudis stefanjudis commented Jun 25, 2026

Copy link
Copy Markdown
Collaborator

Affected Components

  • CLI
  • Create CLI
  • Test
  • Docs
  • Examples
  • Other

Notes for the Reviewer

Deprecates the checkly rules command and removes the AI-context artifact it depended on.

Command (src/commands/rules.ts) — previously read the bundled
dist/ai-context/checkly.rules.md and wrote it into AI IDE config folders
(.cursor/rules, .windsurf/rules, .github/instructions, etc.). That
capability now lives in checkly skills, so the command is reduced to a
deprecation notice:

Rules were deprecated. Use `npx checkly skills`.
  • Keeps its readOnly/idempotent metadata and is marked
    static state = 'deprecated', so oclif also surfaces a deprecation warning.
  • Added a unit test for the message (the command had none before).

AI-context pipeline (scripts/prepare-ai-context.ts) — stops generating
checkly.rules.md and drops the now-dead heading/frontmatter helpers. Renamed
the misleading RULES_OUTPUT_DIR constant (it only feeds onboarding output now).

Release workflow (release.yml) — removes the step that attached
checkly.rules.md to GitHub Releases; the finalize-release job still marks
the release as latest. Updated CONTRIBUTING.md accordingly.

Left in place / for reviewer's call: the release job's
Save LLM rules as an artifact step (uploads the whole dist/ai-context/*
bundle as llm-rules-release) is now orphaned — its only consumer was the
finalize download. I kept it since it archives the full AI-context bundle, not
just rules, and its prerelease twin was already unconsumed. Happy to drop it if
we'd rather not keep dead archival.

New Dependency Submission

None.

The rules command read the bundled checkly.rules.md and wrote it into
AI IDE config folders. That capability now lives in `checkly skills`,
so rules is reduced to a deprecation notice pointing users there.
The rules command no longer reads checkly.rules.md, so drop its
generation from the AI-context pipeline along with the now-dead heading
helpers, and remove the step that attached it to GitHub Releases. The
finalize-release job keeps marking the release as latest.
permissions:
contents: write
steps:
- name: Download LLM rules artifact

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

This part is here to make the rules accessible on the docs via a marketing site redirect. I'll clean that all up.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR deprecates the legacy checkly rules CLI command (which previously generated AI IDE “rules” files) in favor of the newer checkly skills flow, and removes the now-dead checkly.rules.md generation/release plumbing from the AI-context pipeline and release workflow.

Changes:

  • Replace checkly rules behavior with a deprecation notice and mark the command as deprecated in oclif metadata.
  • Update the AI-context build script to stop generating checkly.rules.md and simplify related helpers.
  • Remove the release-workflow step that uploaded checkly.rules.md, and update release documentation accordingly.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
packages/cli/src/commands/rules.ts Removes rules-file generation logic and turns the command into a deprecation stub.
packages/cli/src/commands/tests/rules.spec.ts Adds a unit test asserting the deprecation message output.
packages/cli/scripts/prepare-ai-context.ts Stops generating checkly.rules.md; renames output-dir constant; keeps onboarding assets copy.
CONTRIBUTING.md Updates release instructions to reflect that rules asset is no longer attached.
.github/workflows/release.yml Removes the step that downloaded/uploaded checkly.rules.md and keeps “mark latest” logic.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread packages/cli/src/commands/rules.ts Outdated
Comment thread packages/cli/src/commands/__tests__/rules.spec.ts Outdated
Comment thread CONTRIBUTING.md Outdated
@stefanjudis stefanjudis merged commit 5579d16 into main Jun 26, 2026
13 checks passed
@stefanjudis stefanjudis deleted the deprecate-rules-command branch June 26, 2026 08:48
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