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

Aperta
#1,128 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
55/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
github, javascript
Ambito
backend

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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
Lingua principale
JavaScript
Stelle
942
Fork
238
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di github-community-projects/safe-settings

Tutte le issue di github-community-projects/safe-settings

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.