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

Fix pull_request_target if_merged example #16752

Merged
merged 2 commits into from
Apr 8, 2022
Merged

Conversation

laurelmay
Copy link
Contributor

@laurelmay laurelmay commented Apr 1, 2022

Within the workflow, the event object is still github.event.pull_request, so the merged key is at github.event.pull_request.merged. There is not a github.event.pull_request_target object. This is also reflected in the table for this section in "Webhook event payload".

Why:

Copying and pasting the code sample provided to run on merged PRs will not work; the job will always be skipped because github.event does not have a pull_request_target key on pull_request_target events. As documented in the "Webhook event payload" and as can be seen by dumping the event (${{ toJSON(github.event) }}), the key is pull_request instead.

What's being changed:

The example code snippet is updated to:

if: github.event.pull_request.merged == true

which should work as-is for pull_request_target events to run a job on a merged PR.

Check off the following:

  • I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
  • For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

Within the workflow, the event object is still `github.event.pull_request`, so the `merged` key is at `github.event.pull_request.merged`. There _is not_ a `github.event.pull_request_target` object. This is also reflected in the table for this section in "Webhook event payload".
@welcome
Copy link

welcome bot commented Apr 1, 2022

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Apr 1, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Apr 1, 2022

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
content/actions/using-workflows/events-that-trigger-workflows.md Modified Original

@laurelmay
Copy link
Contributor Author

Quick link to the change is at https://docs-16752-751dec.preview.ghdocs.com/en/actions/using-workflows/events-that-trigger-workflows#running-your-workflow-when-a-pull-request-merges-1

@ramyaparimi ramyaparimi added content This issue or pull request belongs to the Docs Content team actions This issue or pull request should be reviewed by the docs actions team waiting for review Issue/PR is waiting for a writer's review needs SME This proposal needs review from a subject matter expert and removed triage Do not begin working on this issue until triaged by the team labels Apr 4, 2022
@ramyaparimi
Copy link
Contributor

@kylelaker Thanks for opening a pull request! I've triaged this issue for technical review by a subject matter expert 👀

@laurelmay
Copy link
Contributor Author

Thanks! If it helps, I created a sample repo with a pull_request_target-triggered workflow that dumps the github.event object and opened a pull request on that repo. The event details can be seen in the resulting workflow execution. And in that event, there is a pull_request key in the object, but not a pull_request_target.

@ethomson
Copy link
Contributor

ethomson commented Apr 6, 2022

Thanks @kylelaker - looks good to me!

@ramyaparimi ramyaparimi added SME reviewed An SME has reviewed this issue/PR and removed needs SME This proposal needs review from a subject matter expert labels Apr 7, 2022
Copy link
Contributor

@mchammer01 mchammer01 left a comment

Choose a reason for hiding this comment

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

LGTM from a docs perspective!
Thanks for your contribution @kylelaker

@mchammer01 mchammer01 added ready to merge This pull request is ready to merge and removed waiting for review Issue/PR is waiting for a writer's review labels Apr 8, 2022
@mchammer01 mchammer01 merged commit b76e2a1 into github:main Apr 8, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Apr 8, 2022

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

@laurelmay laurelmay deleted the patch-2 branch April 8, 2022 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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 ready to merge This pull request is ready to merge SME reviewed An SME has reviewed this issue/PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants