Skip to content

Commit 49fe9f4

Browse files
authored
Mark multi-approvers workflow as deprecated (#447)
Update the README with deprecation date (September 2, 2025) and migration instructions to the new multi-approvers action.
1 parent 1eede06 commit 49fe9f4

2 files changed

Lines changed: 20 additions & 1 deletion

File tree

.github/workflows/multi-approvers.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ function inOrgApprovedCount(members, submittedReviews, prLogin) {
3838

3939
/** Checks that approval requirements are satisfied. */
4040
async function onPullRequest({orgMembersPath, prNumber, repoName, repoOwner, github, core}) {
41+
core.warning("This workflow is deprecated. Please migrate to the new multi-approvers action found at https://github.com/abcxyz/actions/tree/main/.github/actions/multi-approvers.");
42+
4143
const members = require(orgMembersPath).reduce((acc, v) => acc.set(v.login, v), new Map());
4244
const prResponse = await github.rest.pulls.get({owner: repoOwner, repo: repoName, pull_number: prNumber});
4345
const prLogin = prResponse.data.user.login;
@@ -70,6 +72,8 @@ async function onPullRequest({orgMembersPath, prNumber, repoName, repoOwner, git
7072
* pull_request_review as different status checks.
7173
*/
7274
async function onPullRequestReview({workflowRef, repoName, repoOwner, branch, prNumber, github, core}) {
75+
core.warning("This workflow is deprecated. Please migrate to the new multi-approvers action found at https://github.com/abcxyz/actions/tree/main/.github/actions/multi-approvers.");
76+
7377
// Get the filename of the workflow.
7478
const workflowFilename = workflowRef.split('@')[0].split('/').pop();
7579

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,22 @@ approval from all requested reviewers.
178178
An admin will need to create a new ruleset within the repo to add want_lgtm_all to be included
179179
as a required status check.
180180

181-
#### multi-approvers.yml
181+
#### [DEPRECATED] multi-approvers.yml
182+
183+
> [!CAUTION]
184+
> This workflow will be deprecated on **September 2nd, 2025**.
185+
186+
> [!WARNING]
187+
> Use the new [multi-approvers Action](https://github.com/abcxyz/actions/tree/main/.github/actions/multi-approvers) instead.
188+
189+
**Migration instructions**
190+
191+
To migrate from this deprecated workflow to the new action one must translate
192+
the JSON member file to a GitHub Team. The new action does not support JSON
193+
member files and is therefore not backward compatible with the original
194+
multi-approver workflow.
195+
196+
**[DEPRECATED] Instructions**
182197

183198
Use this workflow to require two in-org approvers for pull requests sent from an
184199
out-of-org user. This prevents in-org users from creating "sock puppet" accounts

0 commit comments

Comments
 (0)