search

onflow / flow-jvm-sdk

Flow JVM SDK
Apache License 2.0
16 stars 16 forks source link

Update flow executable name #104

Closed franklywatson closed 1 month ago

franklywatson commented 1 month ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The pull request updates the command used in the Cadence 1.0 CLI, changing references from flow-c1 to flow. This modification affects various components, including annotations and utility functions, ensuring uniformity in command usage throughout the codebase. While the core functionality remains unchanged, users familiar with the previous command will need to adjust their workflows accordingly.

Changes

File Change Summary
BREAKING_CHANGES.md Updated command from flow-c1 to flow for running tests and examples locally.
common/src/testFixtures/kotlin/org/onflow/flow/common/test/AbstractFlowEmulatorExtension.kt Default value of FlowEmulatorCommand annotation's value parameter changed from flow-c1 to flow.
common/src/testFixtures/kotlin/org/onflow/flow/common/test/FlowEmulatorProjectExtension.kt Default value of FlowEmulatorProjectTest annotation's executable parameter changed from flow-c1 to flow.
common/src/testFixtures/kotlin/org/onflow/flow/common/test/FlowTestUtil.kt Default value of runFlow function's executable parameter changed from flow-c1 to flow, and file path updates made accordingly.
java-example/README.md Removed mention of the CLI being "currently in pre-release" for clarity in installation instructions.
kotlin-example/README.md Removed mention of the CLI being "currently in pre-release" for clarity in installation instructions.
sdk/README.md Removed mention of the CLI being "currently in pre-release" for clarity in installation instructions.

Assessment against linked issues

Objective Addressed Explanation
None ❌ No objectives were provided.

Possibly related issues

Possibly related PRs

Poem

In the meadow where bunnies play,
The command has changed, hip-hip-hooray!
From flow-c1 we now say "flow,"
A simpler path for all to know.
Hops of joy, let’s leap and cheer,
For clearer commands, we hold so dear! 🐇✨

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 1 month ago

Unit Test Results

  53 files  ±0    53 suites  ±0   23s :stopwatch: ±0s 310 tests ±0  310 :heavy_check_mark: ±0  0 :zzz: ±0  0 :x: ±0 

Results for commit ef4d7381. ± Comparison against base commit ef4d7381.

:recycle: This comment has been updated with latest results.

github-actions[bot] commented 1 month ago

SDK Examples Unit Test Results

32 files  32 suites   5m 35s :stopwatch: 65 tests 65 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit 7fcc512f.

:recycle: This comment has been updated with latest results.

github-actions[bot] commented 1 month ago

Integration Test Results

  6 files  ±0    6 suites  ±0   2m 34s :stopwatch: ±0s 30 tests ±0  30 :heavy_check_mark: ±0  0 :zzz: ±0  0 :x: ±0 

Results for commit ef4d7381. ± Comparison against base commit ef4d7381.

:recycle: This comment has been updated with latest results.

github-actions[bot] commented 1 month ago

Common Integration Test Results

1 files  1 suites   7s :stopwatch: 1 tests 1 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit 7fcc512f.