add script to clean up e2e

marcusschiesser commented 1 month ago

Summary by CodeRabbit

New Features
- Introduced a new functionality for managing pipelines in the LlamaCloudIndex system, including project ID retrieval and pipeline deletion.
- Added a dedicated script for cleaning the end-to-end testing environment.
Chores
- Created a new package for the @create-llama/e2e-clean module with necessary dependencies and scripts.

changeset-bot[bot] commented 1 month ago

⚠️ No Changeset found

Latest commit: 2b72d63090f177337cb349182caed309e0fcaab0

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes introduce a new functionality for managing pipelines in the LlamaCloudIndex system through the creation of a clean.ts file. This file includes functions to initialize the API service, retrieve project IDs, and delete pipelines associated with projects. Additionally, a new package.json file is created for the @create-llama/e2e-clean package, defining dependencies and a script to execute the cleaning functionality. The main project’s package.json is also updated to include a new script for executing the clean command.

Changes

File Path	Change Summary
e2e/clean/clean.ts	Added functions: `initService`, `getProjectId`, `deletePipelines` for managing pipelines in LlamaCloudIndex.
e2e/clean/package.json	Introduced new package `@create-llama/e2e-clean` with version `0.1.0`, defined dependencies, and added a clean script.
package.json	Added new script `"e2e:clean"` to execute the clean command for the `@create-llama/e2e-clean` package.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant CleanService
    participant ProjectsService
    participant PipelinesService

    User->>CLI: Execute clean command
    CLI->>CleanService: initService(apiKey)
    CleanService->>ProjectsService: getProjectId(projectName)
    ProjectsService-->>CleanService: return projectId
    CleanService->>PipelinesService: searchPipelines(projectId)
    PipelinesService-->>CleanService: return pipelines
    CleanService->>PipelinesService: deletePipeline(pipelineId)
    PipelinesService-->>CleanService: return deletion status
    CleanService->>CLI: Log deletion results
    CLI->>User: Display completion message

🐇 In the fields where we play,
🧹 Clean up pipelines, hooray!
With a hop and a skip,
We make our scripts flip,
In LlamaCloud, we clear the way!
🌟

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 , please review it.` - `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 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 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. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

run-llama / create-llama