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

Update .GitHub/workflows README.md #33341

Merged
merged 4 commits into from
Dec 26, 2024
Merged
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions .github/workflows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,27 @@
under the License.
-->

# How to fix Workflows for Committers

The following is guidance on how to practically make changes that fix workflows.

1) Create a branch in https://github.com/apache/beam not your fork.

The reason to perform changes to a branch of the main repo instead of your fork is due to the challenge in replicating the environment within which Beam GitHub workflows execute. GitHub workflows allow you to execute against a branch of a repo.

2) Make changes in this branch you anticipate will fix the failing workflow.

3) Run the workflow designating your branch.

In the GitHub workflow interface, you can designate any branch of the repository to run the workflow against. Selecting your branch allows you to test the changes you made. The following screenshot shows an example of this feature.
![image](https://github.com/user-attachments/assets/33ca43fb-b0f8-42c8-80e2-ac84a49e2490)

5) Create a PR, pasting the link to your successful workflow run in the branch

When doing a PR, the checks will not run against your branch. Your reviewer may not know this so you'll want to mention this in your PR description, pasting the link to your successful run.

6) After PR merges, execute the workflow manually to validate your merged changes.

# Running Workflows Manually

Most workflows will get kicked off automatically when you open a PR, push code, or on a schedule.
Expand Down
Loading