Push to default branch attributes coverage to an unrelated fork PR with a same-named head branch

Abierto
#14 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
74/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Tranquilo
Stack tecnológico
github-actions, python, shell
Área
ci-cd, testing-qa

Línea de trabajo

Empieza en la ruta de push de action.yml e inspecciona en upload_coverage.py la precedencia entre pull_request_number y ref. Reproduce el problema con un PR abierto de un fork cuyo head branch coincide con la rama a la que se ha hecho push y verifica que la búsqueda ya no seleccione ese fork. Se considera terminado cuando el push siga atribuyéndose a su rama y se registre la línea base de cobertura de la rama predeterminada.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Summary

On push events, the action associates an open PR via gh pr list --head "${{ github.ref_name }}". That matches by head-branch name across all repositories, so an open cross-repo (fork) PR whose head branch happens to be named the same as the pushed branch gets selected. Since upload_coverage.py prefers pull_request_number over ref, the push's coverage is filed under that unrelated PR instead of the branch, and the branch baseline is never recorded.

Impact

This reliably breaks the default branch baseline: if any contributor has an open PR from their fork's main branch (head branch main), every push to your main is attributed to that PR. The default-branch coverage never populates, so every other PR's coverage comment shows "Coverage data for the main branch is not yet available."

Root cause

action.yml (push path):

else
  COMMIT_OID="${{ github.sha }}"
  REF="${{ github.ref }}"
  PR_NUMBER=$(gh pr list \
    --repo "$GITHUB_REPOSITORY" \
    --head "${{ github.ref_name }}" \   # not scoped to the base repo's own head branches
    --state open \
    --json number \
    --jq '.[0].number // empty' 2>/dev/null || true)
fi

--repo only selects which repository's PR list to query; a fork PR is still part of that list (it targets the base repo, only its head branch lives in the fork). --head <branch> matches the head-branch name regardless of where the head lives, so a fork PR with head branch <branch> is returned. Then upload_coverage.py:

if pr_number:
    payload["pull_request_number"] = int(pr_number)
elif ref:
    payload["ref"] = ref

pull_request_number wins, so the ref (the branch) is dropped from the payload.

Reproduction
  1. The repo has an open PR from a fork whose head branch is named main (head someuser:mainyou:main).
  2. A push to main (the default branch) triggers the upload.
  3. The action log shows:
Upload parameters
  commit_oid: <sha>
  ref: refs/heads/main
  pr_number: <the unrelated fork PR number>
Coverage report uploaded successfully.
  1. Coverage is attributed to that PR; the main baseline stays empty and PRs report "Coverage data for the main branch is not yet available."

Confirmed that gh pr list --repo OWNER/REPO --head main --state open returns the fork PR (isCrossRepository: true), so the existing --repo argument does not prevent this.

Suggested fix

Scope the PR lookup to head branches in the base repository itself, so fork PRs aren't matched:

           COMMIT_OID="${{ github.sha }}"
           REF="${{ github.ref }}"
+          REPO_OWNER="${GITHUB_REPOSITORY%%/*}"
+          REPO_NAME="${GITHUB_REPOSITORY#*/}"
           PR_NUMBER=$(gh pr list \
             --repo "$GITHUB_REPOSITORY" \
             --head "${{ github.ref_name }}" \
             --state open \
-            --json number \
-            --jq '.[0].number // empty' 2>/dev/null || true)
+            --json number,headRepositoryOwner,headRepository \
+            --jq "[.[] | select(.headRepositoryOwner.login == \"$REPO_OWNER\" and .headRepository.name == \"$REPO_NAME\")] | .[0].number // empty" 2>/dev/null || true)

Alternatives: skip PR association entirely when the pushed ref is the default branch, or prefer ref over pull_request_number for push events.

Drafted by Claude (Anthropic AI assistant).

Lenguaje dominante
Python
Estrellas
99
Forks
20
Métricas de merge de PR
Sin PR fusionados en 30 d

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de actions/upload-code-coverage

Todos los issues de actions/upload-code-coverage

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.