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.

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

Jump to bottom

Add more details about workflow_run #531

Merged
merged 8 commits into from
Nov 4, 2020
Merged

Add more details about workflow_run #531

merged 8 commits into from
Nov 4, 2020

Conversation

programmer04
Copy link
Contributor

Why:

Documentation about workflow_run does not contain very important info about its special behavior:

  • run only on default branch regardless of whether it is triggered by a workflow run on other branches or not

  • has to exist on the default branch

This behavior was verified by me and described in community support - kudos to @BrightRan 🙂

What's being changed:

New info added

Check off the following:

@programmer04
Add more details about workflow_run
be12885 
* need to exists on default branch

* run only on it
@welcome
Copy link

welcome bot commented Oct 14, 2020

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@janiceilene
Copy link
Contributor

Thanks for opening a PR @programmer04! I'll get this triaged and up for review ⚡

@janiceilene janiceilene added actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team labels Oct 15, 2020
@github-actions
Copy link
Contributor

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Oct 23, 2020
@janiceilene janiceilene removed the stale There is no recent activity on this issue or pull request label Oct 23, 2020
@janiceilene
Copy link
Contributor

Sorry about the delay @programmer04! This is definitely not stale 🙃 we're a small team working through lots of amazing Hacktoberfest PRs. Thank you for your patience 💖

@janiceilene janiceilene mentioned this pull request Oct 26, 2020
Closed
@janiceilene janiceilene added the hacktoberfest-accepted We might not merge this PR before Nov 1st, but it's a wonderful Hacktoberfest contribution! label Oct 27, 2020
@snyk-bot snyk-bot mentioned this pull request Nov 1, 2020
Open
rachmari
rachmari reviewed Nov 4, 2020
View reviewed changes
Copy link
Contributor

@rachmari rachmari left a comment

Choose a reason for hiding this comment

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

@programmer04 thank you for the docs update!! 🙌 Your change actually uncovered a larger bug in this section of the docs. This section doesn't include the table that describes which commit and reference are used when running the workflow. Instead of adding the information to the description, I've suggested adding the missing table.

content/actions/reference/events-that-trigger-workflows.md Show resolved Hide resolved
content/actions/reference/events-that-trigger-workflows.md Outdated Show resolved Hide resolved
@rachmari rachmari self-assigned this Nov 4, 2020
@BrightRan
Copy link

Hi guys,
The docs seems still is not updated.

@Justka89 Justka89 mentioned this pull request Nov 4, 2020
Closed
@programmer04 @rachmari
Add table about payload, activity, etc. to workflow_run section
00d1a59 
Co-authored-by: Rachael Sewell <rachmari@github.com>
@programmer04 programmer04 requested a review from rachmari November 4, 2020 09:07
@programmer04
Copy link
Contributor Author

programmer04 commented Nov 4, 2020 •
edited
Loading

Thanks, @rachmari for your suggestions I've applied them. 🙂

Moreover, maybe you can pass a feature request to the team in GH taking care of workflow_run... Having a workflow_run which works in the way described below in my opinion would be useful too.

On branch feature-1 from some event, workflow-A is triggered. Next dependant workflow-B (which is triggered by successful finishing workflow-A by using workflow_run) instead of running on the default branch (current default and the only one behavior) can be specified to be run on a current branch in this case feature-1

rachmari
rachmari approved these changes Nov 4, 2020
View reviewed changes
Copy link
Contributor

@rachmari rachmari left a comment

Choose a reason for hiding this comment

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

@programmer04 thank you so much for getting this updated! 🙌 This looks great. I'll get it merged right away! 🚢

I've also created an internal customer feedback issue to track your request:

Moreover, maybe you can pass a feature request to the team in GH taking care of workflow_run... Having a workflow_run which works in the way described below in my opinion would be useful too.

On branch feature-1 from some event, workflow-A is triggered. Next dependant workflow-B (which is triggered by successful finishing workflow-A by using workflow_run) instead of running on the default branch (current default and the only one behavior) can be specified to be run on a current branch in this case feature-1

@rachmari rachmari merged commit 11c251b into github:main Nov 4, 2020
@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2020

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours.

@programmer04 programmer04 deleted the patch-1 branch November 4, 2020 21:08
This was referenced Dec 27, 2020
Open
Merged
BlaineEXE added a commit to BlaineEXE/rook that referenced this pull request Nov 4, 2021
@BlaineEXE
Revert "ci: trigger push build action after tag creation"
30e02c1 
This reverts commit c53304c.

After experimenting with this release, we have found that the
`workflow_run` action source doesn't work for branches. The
documentation was updated with this PR and has more detail.
github/docs#531

For now, we will revert back to using on.push.tags = ["v*"]

Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
@BlaineEXE BlaineEXE mentioned this pull request Nov 4, 2021
Merged
10 tasks
mergify bot pushed a commit to rook/rook that referenced this pull request Nov 4, 2021
@BlaineEXE
Revert "ci: trigger push build action after tag creation"
e5cca41 
This reverts commit c53304c.

After experimenting with this release, we have found that the
`workflow_run` action source doesn't work for branches. The
documentation was updated with this PR and has more detail.
github/docs#531

For now, we will revert back to using on.push.tags = ["v*"]

Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
(cherry picked from commit 30e02c1)
parth-gr pushed a commit to parth-gr/rook that referenced this pull request Feb 22, 2022
@BlaineEXE @parth-gr
Revert "ci: trigger push build action after tag creation"
1d34049 
This reverts commit c53304c.

After experimenting with this release, we have found that the
`workflow_run` action source doesn't work for branches. The
documentation was updated with this PR and has more detail.
github/docs#531

For now, we will revert back to using on.push.tags = ["v*"]

Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
parth-gr pushed a commit to parth-gr/rook that referenced this pull request Feb 22, 2022
@BlaineEXE @parth-gr
Revert "ci: trigger push build action after tag creation"
10cfedb 
This reverts commit c53304c.

After experimenting with this release, we have found that the
`workflow_run` action source doesn't work for branches. The
documentation was updated with this PR and has more detail.
github/docs#531

For now, we will revert back to using on.push.tags = ["v*"]

Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
jnidzwetzki pushed a commit to jnidzwetzki/docs that referenced this pull request Oct 6, 2022
@jacobprall
fix typo (github#531)
feb2cdd
@Anmar1988260 Anmar1988260 mentioned this pull request Nov 30, 2023
Open
@montana910318 montana910318 mentioned this pull request Nov 30, 2023
Open
@makombelajob makombelajob mentioned this pull request Nov 30, 2023
Open
@qmutz qmutz mentioned this pull request Nov 30, 2023
Open
@oudomskn oudomskn mentioned this pull request Nov 30, 2023
Open
@Visva92 Visva92 mentioned this pull request Nov 30, 2023
Open
@ryan-ally ryan-ally mentioned this pull request Nov 30, 2023
Open
@mongoloidkhulmikuki366385 mongoloidkhulmikuki366385 mentioned this pull request Dec 1, 2023
Open
@aliscco aliscco mentioned this pull request Dec 1, 2023
Open
@mongoloidkhulmikuki366385 mongoloidkhulmikuki366385 mentioned this pull request Dec 1, 2023
Open
@Chantall1602 Chantall1602 mentioned this pull request Oct 17, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rachmari rachmari rachmari approved these changes

Assignees

@rachmari rachmari

Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team hacktoberfest-accepted We might not merge this PR before Nov 1st, but it's a wonderful Hacktoberfest contribution!
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@programmer04 @janiceilene @BrightRan @rachmari