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 cleanup example to use pull_request_target trigger #31322

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Mogyuchi
Copy link

@Mogyuchi Mogyuchi commented Jan 29, 2024

Why:

Closes: #31321

What's being changed (if available, include any code snippets, screenshots, or gifs):

image

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

Copy link

welcome bot commented Jan 29, 2024

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 Jan 29, 2024
Copy link
Contributor

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
actions/using-workflows/caching-dependencies-to-speed-up-workflows.md fpt
ghec
ghes@ 3.11 3.10 3.9 3.8
fpt
ghec
ghes@ 3.11 3.10 3.9 3.8

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

@nguyenalex836 nguyenalex836 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 and removed triage Do not begin working on this issue until triaged by the team labels Jan 29, 2024
@nguyenalex836
Copy link
Contributor

@Mogyuchi Thanks so much for opening a PR! I'll get this triaged for review ✨

Copy link
Contributor

@corneliusroemer corneliusroemer left a comment

Choose a reason for hiding this comment

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

I tested this change and it does not fix the issue unfortunately

I still get the same error, at least when triggering manually (having added workflow_dispatch: to do so)

Maybe that's as expected, maybe the permissions are only granted when you merge a PR, hard to tell/test

I see, the right permissions might be auto-granted due to this change:

When a workflow is triggered by the pull_request_target event, the GITHUB_TOKEN is granted read/write repository permission, even when it is triggered from a public fork. For more information, see "Events that trigger workflows."
https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token

I've added explicit token permissions in #31582, this allowed me to test via workflow_dispatch:

@Mogyuchi
Copy link
Author

Mogyuchi commented Mar 7, 2024

@jc-clark
#31582 (comment)

What would you think of keeping pull_request as the triggering event here but adding a note above the example that links to "pull_request_target" and describes the cross-repo pull request use case?

No… I think we should use "pull_request_target".
Especially in public repositories, I think there is a possibility that cross-repo pull requests will be made even if the repository owner does not assume it. Therefore, I think we should present the example that takes into account the existence of cross-repo pull requests.

Boozing1973

This comment was marked as spam.

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 waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The workflow named "cleanup caches by a branch" is not working as expected
4 participants