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.

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

Simplify cache cleanup actions #5215

Merged
merged 1 commit into from
Sep 5, 2024

Conversation

WeiqunZhang
Copy link
Member

In our old approach, a workflow file contains a job that uploads the PR number as an artifact. While the PR is still open, the workflow_run triggered by it will download the artifact and use the information to clean up all except the last used cache associated with that original workflow. When a PR is merged or closed, there will be a post-pr workflow that uploads the PR number as an artifact and triggers a workflow_run that clean up all caches associated with the PR. The reason we did it this way was in the cache cleanup workflows, we did not find an easy way to get the number of the PR triggering them. This is not convenient because we have to add jobs uploading artifacts to workflow files.

After some experiments, we have found a reliable way to find the PR number without using artifacts. The workflow_run's payload always contains the head SHA of the commit that triggers it, whether the PR comes from a fork or not. We can then use gh pr list to search for that head and obtain the PR number.

In our old approach, a workflow file contains a job that uploads the PR
number as an artifact. While the PR is still open, the workflow_run
triggered by it will download the artifact and use the information to clean
up all except the last used cache associated with that original
workflow. When a PR is merged or closed, there will be a post-pr workflow
that uploads the PR number as an artifact and triggers a workflow_run that
clean up all caches associated with the PR. The reason we did it this way
was in the cache cleanup workflows, we did not find an easy way to get the
number of the PR triggering them. This is not convenient because we have to
add jobs uploading artifacts to workflow files.

After some experiments, we have found a reliable way to find the PR number
without using artifacts. The workflow_run's payload always contains the head
SHA of the commit that triggers it, whether the PR comes from a fork or
not. We can then use `gh pr list` to search for that head and obtain the PR
number.
@ax3l ax3l added the component: tests Tests and CI label Sep 5, 2024
@ax3l ax3l self-assigned this Sep 5, 2024
Copy link
Member

@ax3l ax3l left a comment

Choose a reason for hiding this comment

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

Thank you! Very nice.

@ax3l ax3l added the cleaning Clean code, improve readability label Sep 5, 2024
@ax3l ax3l enabled auto-merge (squash) September 5, 2024 00:29
@ax3l ax3l disabled auto-merge September 5, 2024 00:32
@ax3l ax3l merged commit c9d79cc into ECP-WarpX:development Sep 5, 2024
32 of 40 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleaning Clean code, improve readability component: tests Tests and CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants