Environment reviewers silently dropped when reviewer access is granted in the same sync

Open
#1,128 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 2 days

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
55/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
github, javascript
Domain
backend

Research direction

Start in lib/settings.js at the updateRepos() paths linked in the issue, then trace how the teams and environments child plugins are scheduled. Check how the environments plugin sends its PUT and what tests cover a full sync. Done means one sync that grants a team's repo access also creates the environment with that team as a reviewer.

Written by the indexing model from the issue text.

Description

Problem Description

What is actually happening

A single config change that both grants a team repo access and names that team as an environment reviewer creates the environment without the reviewer. Example repo config:

teams:
  - name: deployers
    permission: maintain

environments:
  - name: prod
    reviewers:
      - type: Team
        id: 12345678 # deployers

updateRepos() runs every child plugin concurrently, so the environments plugin's PUT can land before the teams plugin grants access:

https://github.com/github-community-projects/safe-settings/blob/e19444e0d69de050ba55d0262b71fcd8a98edfef/lib/settings.js#L2150-L2152

The no-repo-config branch has the same pattern:

https://github.com/github-community-projects/safe-settings/blob/e19444e0d69de050ba55d0262b71fcd8a98edfef/lib/settings.js#L2196-L2201

GitHub's PUT /repos/{owner}/{repo}/environments/{environment_name} returns 200 for a reviewer that has no repo access, but it doesn't add the reviewer. The sync reports success, and the environment has no required reviewers until a later sync runs. Because nop mode doesn't render environment changes, the plan doesn't flag it either.

Debug log from the affected full sync, in order:

GitHub request: PUT https://api.github.com/repos/<org>/<repo>/environments/prod - 200
GitHub request: PUT https://api.github.com/orgs/<org>/teams/<team>/repos/<org>/<repo> - 204
What is the expected behavior

The environment is created with the configured reviewer in the same sync that grants the reviewer repo access.

Error output, if available

None. Every request returns 2xx.


Context

Are you using the hosted instance of probot/settings or running your own?

Running our own, via full-sync.js in GitHub Actions.

If running your own instance, are you using it with github.com or GitHub Enterprise?

github.com

Version of probot/settings

3.0.0, and the same code is on main-enterprise at e19444e0d69de050ba55d0262b71fcd8a98edfef

Version of GitHub Enterprise
Dominant language
JavaScript
Stars
942
Forks
238
PR merge metrics
No merged PRs in 30d

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github-community-projects/safe-settings

All issues in github-community-projects/safe-settings

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.