Skip to content

Update the docs for pr optimizations #805

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

Merged
merged 2 commits into from
Oct 9, 2025
Merged

Update the docs for pr optimizations #805

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c8fe2d
revert the init selection arrow to default.
misrasaurabh1 Oct 9, 2025
e6514e7
Merge branch 'main' into update-docs
misrasaurabh1 Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions docs/optimizing-with-codeflash/codeflash-github-actions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,16 @@ icon: "github"
---


Optimizing new code in Pull Requests is the best way to ensure that all code you and your team ship is performant
in the future. Automating optimization in the Pull Request stage how most teams use Codeflash, to
Optimizing new code in Pull Requests is the best way to ensure that all code you and your team ship is always performant.
Automating optimization in the Pull Request stage is how most teams use Codeflash, to
continuously find optimizations for their new code.

To scan new code for performance optimizations, Codeflash uses a GitHub Action workflow which runs
the Codeflash optimization logic on the new code in every pull request.
If the action workflow finds an optimization, it communicates with the Codeflash GitHub
App and asks it to suggest new changes to the pull request.

This is the most useful way of using Codeflash, where you set it up once and all your new code gets optimized.
So setting this up is highly recommended.
We highly recommend setting this up, since once you set it up all your new code gets optimized.

## Pull Request Optimization 30 seconds demo
<iframe width="640" height="400" src="https://www.youtube.com/embed/nqa-uewizkU?si=H1wb1RvPp-JqvKPh" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
Expand Down Expand Up @@ -68,8 +67,15 @@ name: Codeflash

on:
pull_request:
paths:
- '**' # Modify this to the path of your project in a mono-repo. Codeflash will only run when code in this directory is modified.
workflow_dispatch:

concurrency:
# Any new push to the PR will cancel the previous run, so that only the latest code is optimized
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
optimize:
name: Optimize new code in this PR
Expand Down Expand Up @@ -103,11 +109,17 @@ jobs:
<Warning>
**Replace the TODOs** in the workflow file above with your project's specific setup commands.
</Warning>
Set the `working-directory` parameter in the yaml file, if the commands are meant to be run from some other directory.
Copy link
Contributor

@Saga4 Saga4 Oct 9, 2025

Choose a reason for hiding this comment

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

Where is the working-directory in the above yaml?

</Step>

<Step title="Choose Your Package Manager">
Customize the dependency installation based on your Python package manager:

The workflow will need to be set up in such a way the Codeflash can create and
run tests for functionality and speed, so the stock YAML may need to be altered to
suit the specific codebase. Typically the setup steps for a unit test workflow can
be copied.

<CodeGroup>
```yaml Poetry
- name: Install Project Dependencies
Expand Down
Loading