Skip to content

Conversation

@christerswahn
Copy link
Collaborator

@christerswahn christerswahn commented Aug 6, 2025

In preparation to house multiple packages in the cli_tools repo, this moves all the current package's files into a new subdirectory packages/cli_tools. This enables other packages to be added.

Summary by CodeRabbit

  • Chores
    • Improved continuous integration workflow to better organize and identify package-specific jobs.
    • Updated publishing workflow to trigger only on tags prefixed with "cli_tools-v" and set the working directory for publishing tasks.
    • Revised publishing documentation to reflect new tag naming conventions including the package name prefix.

@coderabbitai
Copy link

coderabbitai bot commented Aug 6, 2025

📝 Walkthrough

Walkthrough

The CI and publish workflows for the Dart CLI tools package were updated. The CI workflow now uses a matrix for package names and runs commands within the packages/cli_tools directory. The publish workflow trigger was changed to match tags prefixed with cli_tools-v, and its job now specifies the correct working directory. The package publishing documentation was also updated to reflect the new tag naming convention.

Changes

Cohort / File(s) Change Summary
CI Workflow Matrix and Directory Update
.github/workflows/ci.yml
Added a matrix for package names, scoped jobs to packages/cli_tools, and updated step names.
Publish Workflow Trigger and Directory
.github/workflows/publish-cli_tools.yaml
Changed tag trigger to cli_tools-v* pattern and set working directory to packages/cli_tools.
Publishing Documentation Update
packages/cli_tools/PUBLISH.md
Updated Git tag naming convention to require package name prefix (e.g., cli_tools-vX.Y.Z).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Suggested reviewers

  • Isakdl

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f2a9d33 and 4263560.

📒 Files selected for processing (1)
  • packages/cli_tools/PUBLISH.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/cli_tools/PUBLISH.md
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch pkg-split

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@christerswahn christerswahn marked this pull request as ready for review August 6, 2025 09:25
@christerswahn christerswahn requested a review from SandPod August 6, 2025 09:25
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 98d592b and f2a9d33.

⛔ Files ignored due to path filters (1)
  • packages/cli_tools/pubspec.lock is excluded by !**/*.lock
📒 Files selected for processing (2)
  • .github/workflows/ci.yml (1 hunks)
  • .github/workflows/publish-cli_tools.yaml (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: for this project, avoid review comments that simply repeat compile-time errors the dart analyzer alr...
Learnt from: christerswahn
PR: serverpod/cli_tools#47
File: lib/src/config/options.dart:552-567
Timestamp: 2025-06-12T14:55:38.006Z
Learning: For this project, avoid review comments that simply repeat compile-time errors the Dart analyzer already reports; focus on issues not caught by the analyzer.

Applied to files:

  • .github/workflows/ci.yml
🔇 Additional comments (3)
.github/workflows/publish-cli_tools.yaml (1)

14-15: Confirm working-directory is a supported input of the reusable workflow

dart-lang/setup-dart/.github/workflows/publish.yml@v1 must expose an input named working-directory; otherwise this job will fail with
inputs.working-directory: unknown input.
Please double-check the upstream workflow definition or pin to a commit that contains that input.

.github/workflows/ci.yml (2)

17-17: Good forward-looking addition of package matrix

Introducing a package dimension makes the workflow ready for future multi-package support without impacting current behaviour.


24-27: Repetition unavoidable – nothing to fix

Duplicating working-directory: packages/${{ matrix.package }} per step is required because
defaults.run.working-directory does not allow expression interpolation.
Implementation is correct as-is.

Also applies to: 41-44, 58-60

Copy link
Contributor

@SandPod SandPod left a comment

Choose a reason for hiding this comment

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

LGTM Given my comments are addressed.

@christerswahn christerswahn merged commit a4904c3 into main Aug 6, 2025
9 checks passed
@christerswahn christerswahn deleted the pkg-split branch August 6, 2025 11:23
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