honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(dev-infra): merge tool should ensure that token has `workflow` oauth scope (#41989) 

Currently if a PR modifies any file that configures a Github action
(e.g. a workflow file), the caretaker might face an error when merging
such PR:

```
! [remote rejected]       merge_pr_target_11.2.x -> 11.2.x (refusing to allow a Personal Access Token to create or update workflow
```

This happens because Github requires the token being used for the
push operation to have the `workflow` scope set. This is a special
scope added by Github to ensure that no changes can be made on
upstream branches that might expose the `GITHUB_TOKEN` environment
variable, which is available for push builds and could cause the
token being leaked.

With this commit we enforce that the caretaker adds the workflow
scope to their github token. Since PRs can only be merged if reviewed
thoroughly, it's acceptable to allow workflow file changes being
merged through the merge tool by the caretaker (especially since we
also allow CircleCI config files being merged with the default
`repo`/`public_repo` scope).

PR Close #41989
This commit is contained in:
Paul Gschwendtner 2021-05-07 16:15:25 +02:00 committed by Alex Rickabaugh
parent 3a48c0739d
commit 2843f15e8c
2 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
dev-infra/ng-dev.js
View File

@ -4215,6 +4215,14 @@ var PullRequestMergeTask = /** @class */ (function () {
missing.push('public_repo');
}
}
// Pull requests can modify Github action workflow files. In such cases Github requires us to
// push with a token that has the `workflow` oauth scope set. To avoid errors when the
// caretaker intends to merge such PRs, we ensure the scope is always set on the token before
// the merge process starts.
// https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes
if (!scopes.includes('workflow')) {
missing.push('workflow');
}
})];
case 1:
hasOauthScopes = _c.sent();

9
dev-infra/pr/merge/task.ts
View File

@ -74,6 +74,15 @@ export class PullRequestMergeTask {
missing.push('public_repo');
}
}
// Pull requests can modify Github action workflow files. In such cases Github requires us to
// push with a token that has the `workflow` oauth scope set. To avoid errors when the
// caretaker intends to merge such PRs, we ensure the scope is always set on the token before
// the merge process starts.
// https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes
if (!scopes.includes('workflow')) {
missing.push('workflow');
}
});
if (hasOauthScopes !== true) {