search

osmosis-labs / osmosis

The AMM Laboratory
https://app.osmosis.zone
Apache License 2.0
879 stars 568 forks source link

Added GH action to trigger pprof automation #8483

Closed alessandrolomanto closed 2 weeks ago

alessandrolomanto commented 2 weeks ago

Closes: PLAT-258

What is the purpose of the change

This pull request introduces a new GitHub Actions workflow to automate the triggering of pprof profiling automation upon the creation of a new tag. The workflow uses the peter-evans/repository-dispatch action to send a dispatch event with relevant details, such as commit SHA, tag name, and profiling parameters, to the target repository.

Required Secrets:

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The new addition of .github/workflows/pprof-auto.yml introduces a GitHub Actions workflow that automatically handles pprof automation upon the creation of new tags in the repository. This setup ensures that pprof processes are triggered and configured correctly whenever a new tag is pushed, streamlining performance profiling and automation activities within the project.

Changes

File Change Summary
.github/workflows/pprof-auto.yml Introduces a GitHub Actions workflow for pprof automation triggered by new tag creation.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub
    participant Workflow Runner

    Developer->>GitHub: Push new tag
    GitHub->>Workflow Runner: Trigger pprof-auto.yml workflow
    Workflow Runner->>Workflow Runner: Set up workflow environment
    Workflow Runner->>Workflow Runner: Dispatch custom event for pprof automation
    Workflow Runner->>Workflow Runner: Execute pprof automation tasks
Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 3999fb4e0c7045463ab5f1d9e1072fcb9070ade7 and a66e83b1cdadae601d55d13ed31a036cf7026f03.
Files selected for processing (1) * .github/workflows/pprof-auto.yml (1 hunks)
Additional comments not posted (5)
.github/workflows/pprof-auto.yml (5)
`1-2`: **LGTM!** The comment is clear and provides a good overview of the workflow's purpose. --- `3-4`: **LGTM!** The workflow name is descriptive and aligns well with its purpose. --- `5-10`: **LGTM!** The configuration correctly sets the workflow to trigger on any new tag push. --- `11-19`: **LGTM!** The job and runner configuration is appropriate and follows standard practices. --- `20-39`: **LGTM! But verify the necessity of empty strings for `osmosis_sdk_fork_hash` and `osmosis_comet_fork_hash`.** The repository dispatch step is well-defined and the parameters in the `client-payload` are comprehensive. However, ensure that the empty strings for `osmosis_sdk_fork_hash` and `osmosis_comet_fork_hash` are intentional and necessary.
--- 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 as 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. 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](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.