Feature toggle for round-robin assignment

[plowin]

Hi nice workflow which we would like to use with an additional functionality:
When specifying a team as either reviewer or assignee and then configure numberOfAssignees, it always take the first user from the list. It would be nice to have some round-robin functionality here.

Expected Behavior

Have a feature-toggle like randomReviewers and randomAssignees that can be set to true to assign random ppl from the team or list of people.

Possible Solution

Some changes around

auto-assign/src/util.ts

Line 67 in c3701c7

teams: sampleSize(teams, count),

[bubkoo]

Hi @plowin Thanks for opening your issue here!

The code here using lodash's sampleSize method to randomly pick count user from teams. So it already has random functionality.

It would be very helpful if you could provide the contents of your workflow.

[plowin]

Hi, thanks a lot for the quick reply!
With a team of 3-4 people, it is probably very unlikely to always have the same assignee:

My workflow is here, I tried using a team even though this is not documented:

    steps:
      - uses: wow-actions/auto-assign@v2
        with:
          GITHUB_TOKEN: ${{ secrets.TEST_TOKEN }}
          reviewers: org-plowin/team-plowin
          assignees: org-plowin/team-plowin # b1tamara,plowin,stefanlay
          numberOfReviewers: 1
          numberOfAssignees: 1
          skipKeywords: wip, draft

[bubkoo]

@plowin
I catch the issue. Adding a team to assignees is not supported by GitHub. So I'm trying to fetch the members of a team, then add the members as assignees in this PR.

In order to test the action I create a team "authors" with two members: "bubkoo" and "srm-bot". And update my test workflow with:

        with:
          GITHUB_TOKEN: ${{ env.BOT_TOKEN }}
          addReviewers: true
          addAssignees: true
          numberOfReviewers: 1
          numberOfAssignees: 1
          reviewers: |
            /authors
          assignees: |
            this-is-an-unknown-assignee
            /authors
          skipKeywords: wip
          excludeLabels: dependencies, wip

The result looks like what you'd expect.

Note that the default ${{ secrets.GITHUB_TOKEN }} does not have the permission to add teams as reviewers or to list members of a team. As a workaround:

• First, create a personal access token (PAT) with repo and admin:org permissions.
• Then, make the PAT available to our actions by adding the token as a secret.
• Finally, replace the GITHUB_TOKEN with the new secret, e.g. GITHUB_TOKEN: ${{ secrets.NAME_OF_MY_SECRET_CONTAINING_PAT_WITH_REPO_ACCESS }} instead of GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}.

Or with a cool but slightly cumbersome solution: create a private github app for your org with custom permissions and avatar, then use the app token in out workflow, e.g. wow-actions-bot.

[plowin]

cool, I'll try it out once you release a v3!

[plowin]

Hi, in my test-action I tried multiple variations and in the end even copied the exact action you pasted above but I keep getting the same error:

runTypeError: Cannot read properties of undefined (reading 'length')
--
runCannot read properties of undefined (reading 'length')

I am not familiar with debugging GH actions and error output does not help a lot here. v2 worked with the variations I tried.

The GH history of this file shows you what I tried, they all fail with the exact same error. The PAT has org:admin scope.

[bubkoo]

@plowin v3.0.2 was released. Try to rerun your workflow.