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

Move issues and pull_request_target workflows to GitHub App #32849

Merged
merged 1 commit into from
Aug 4, 2023

Conversation

justinretzolk
Copy link
Member

@justinretzolk justinretzolk commented Aug 3, 2023

Description

This PR moves the issues.yml and pull_request_target.yml workflows over to use a GitHub App for authentication when labeling or adding items to the GitHub Project. This is necessary, as using the automatically generated GitHub token does not allow the workflow to trigger itself, so when the workflows label something (e.g. with partner), it won't re-trigger the workflow, causing the label event, which is what we rely on to add the item to the project.

Note: this will require ensuring that our GitHub App has write permissions for issues and pull requests, as well as read/write for organization projects.

References

  • An example of a partner PR being opened, labeled appropriately, and not being added to the project
  • GitHub Documentation indicating the limitation that we're hitting:

When you use the repository's GITHUB_TOKEN to perform tasks, events triggered by the GITHUB_TOKEN, with the exception of workflow_dispatch and repository_dispatch, will not create a new workflow run. This prevents you from accidentally creating recursive workflow runs. For example, if a workflow run pushes code using the repository's GITHUB_TOKEN, a new workflow will not run even when the repository contains a workflow configured to run when push events occur. For more information, see "Automatic token authentication."

If you do want to trigger a workflow from within a workflow run, you can use a GitHub App installation access token or a personal access token instead of GITHUB_TOKEN to trigger events that require a token.

Output from Acceptance Testing

N/a, Actions

@github-actions
Copy link

github-actions bot commented Aug 3, 2023

Community Note

Voting for Prioritization

  • Please vote on this pull request by adding a 👍 reaction to the original post to help the community and maintainers prioritize this pull request.
  • Please see our prioritization guide for information on how we prioritize.
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

For Submitters

  • Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
  • For new resources and data sources, use skaff to generate scaffolding with comments detailing common expectations.
  • Whether or not the branch has been rebased will not impact prioritization, but doing so is always a welcome surprise.

@github-actions github-actions bot added size/S Managed by automation to categorize the size of a PR. repository Repository modifications; GitHub Actions, developer docs, issue templates, codeowners, changelog. github_actions Pull requests that update Github_actions code prioritized Part of the maintainer teams immediate focus. To be addressed within the current quarter. labels Aug 3, 2023
Copy link
Contributor

@ewbankkit ewbankkit left a comment

Choose a reason for hiding this comment

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

LGTM 🚀.

@justinretzolk justinretzolk merged commit 15c58dd into main Aug 4, 2023
31 checks passed
@justinretzolk justinretzolk deleted the m-labeler-token branch August 4, 2023 15:45
@github-actions github-actions bot added this to the v5.12.0 milestone Aug 4, 2023
github-actions bot pushed a commit that referenced this pull request Aug 4, 2023
@github-actions
Copy link

This functionality has been released in v5.12.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

@github-actions
Copy link

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 10, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
github_actions Pull requests that update Github_actions code prioritized Part of the maintainer teams immediate focus. To be addressed within the current quarter. repository Repository modifications; GitHub Actions, developer docs, issue templates, codeowners, changelog. size/S Managed by automation to categorize the size of a PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants