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.

Sign up for GitHub

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

Jump to bottom

chore: update dist config #321

Merged
merged 1 commit into from
May 10, 2024
Merged

chore: update dist config #321

merged 1 commit into from
May 10, 2024

Conversation

Gankra
Copy link
Contributor

@Gankra Gankra commented May 9, 2024 •
edited by coderabbitai bot
Loading

  • set dist=true to override publish=false
  • set a 'grit' bin-alias
  • add temp names for npm/homebrew packages
  • normalize repository urls to match what rust tools expect

I wish there was a good way to do the subdir thing for repository. We could potentially override homepage here as an alternative.

Summary by CodeRabbit

  • Chores
    • Updated repository information across various components to reflect their inclusion in a unified workspace.
    • Enhanced package distribution settings for better integration with package managers like npm and Homebrew.

@Gankra Gankra requested a review from a team as a code owner May 9, 2024 16:30
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 9, 2024 •
edited
Loading

Walkthrough

Walkthrough

The updates across various Cargo.toml files in the GritQL project mainly involve integrating and refining repository linkage and workspace settings. These changes ensure that each component is correctly identified as part of the workspace, and additional metadata for distribution (like npm and homebrew) is specified, enhancing the project's manageability and distribution readiness.

Changes

File Path Changes
Cargo.toml, crates/cli_bin/Cargo.toml Added repository field. Updated distribution settings, defined package names, set binary aliases.
.../grit-pattern-matcher/Cargo.toml, .../grit-util/Cargo.toml Changed repository settings to indicate workspace membership.
Recent Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 98f9db8 and 4c539f1.
Files selected for processing (4)
  • Cargo.toml (1 hunks)
  • crates/cli_bin/Cargo.toml (2 hunks)
  • crates/grit-pattern-matcher/Cargo.toml (1 hunks)
  • crates/grit-util/Cargo.toml (1 hunks)
Files skipped from review as they are similar to previous changes (4)
  • Cargo.toml
  • crates/cli_bin/Cargo.toml
  • crates/grit-pattern-matcher/Cargo.toml
  • crates/grit-util/Cargo.toml

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@Gankra
Copy link
Contributor Author

Gankra commented May 9, 2024

add temp names for npm/homebrew packages

it's desirable for these to be temp for us to do some test runs / prevent accidents

morgante
morgante reviewed May 9, 2024
View reviewed changes
crates/cli_bin/Cargo.toml Outdated
default-features = false
features = ["marzano-cli/grit_beta"]
# the npm package should have this name
npm-package = "launcher2"
Copy link
Contributor

Choose a reason for hiding this comment

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

Would we want this to be @getgrit/launcher to replace our existing npm packge?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, I just wasn't sure if you'd want to do a few test runs on a separate package name first -- but we can just set the final one now.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i've updated it to "launcher" now

@Gankra
chore: update dist config
4c539f1 
* set dist=true to override publish=false
* set a 'grit' bin-alias
* add names for npm/homebrew packages
* normalize repository urls to match what rust tools expect

I wish there was a good way to do the subdir thing for repository.
We could potentially override homepage here as an alternative.
@morgante morgante merged commit bac2b39 into getgrit:main May 10, 2024
6 checks passed
@mistydemeo mistydemeo deleted the dist-config branch May 13, 2024 16:00
This was referenced May 14, 2024
Closed
Closed
@github-actions github-actions bot mentioned this pull request May 29, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@morgante morgante morgante approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Gankra @morgante