Filter trigger-only commits out of Crane iteration summaries

Abierto Apto para principiantes
#6 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
85/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Tranquilo
Stack tecnológico
github-actions, markdown

Línea de trabajo

Comienza con workflows/crane.md e inspecciona el setup existente de prompt-test mencionado en el issue. Actualiza las indicaciones de accepted-iteration y añade una prueba que cubra la redacción de trigger-commit; estará terminado cuando los trigger commits se ignoren si existen commits sustantivos, pero se vinculen cuando sean el único commit.

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

Descripción

enhancement

Background

In githubnext/apm, Crane sometimes produced or encountered process-only commits such as ci: trigger checks. Those commits are useful to make CI run, but they are not the accepted migration work. If Crane summarizes that commit as the latest change, reviewers get a misleading PR update.

APM updated its local Crane prompt to ignore ci: trigger checks when selecting the commit to link in an accepted iteration summary, unless that trigger commit is the only new commit available.

Problem

Long-running migration PRs can accumulate commits that are not substantive migration changes:

  • CI trigger commits.
  • Empty or near-empty process commits.
  • Retry commits whose only purpose is to wake checks.

If the PR body or PR comment points at one of those instead of the actual accepted migration commit, the update says little about the work that landed. This was one reason the APM Crane PR looked stale or untrustworthy from the review surface.

Proposed implementation

Update the accepted-iteration summary guidance in workflows/crane.md so the commit selection rule is explicit:

  • Link the real accepted migration commit when available.
  • Ignore a commit with subject exactly ci: trigger checks when another new substantive commit exists.
  • Consider documenting a small ignore-list for future process-only subjects, for example ci: trigger checks and chore: trigger checks.
  • If a trigger-only commit is the only new commit, link it but state that no substantive migration commit was found.

This should apply anywhere Crane chooses a short SHA for:

  • PR comments.
  • PR body updates.
  • Migration issue comments.
  • Repo-memory iteration history.

Implementation notes

This can start as prompt guidance only. If Crane later moves summary generation into code, expose the ignore-list as a small function with test coverage.

Suggested prompt wording:

Commit short SHA linked to the commit URL, ignoring a `ci: trigger checks` commit unless it is the only new commit.

Suggested test coverage

Add a prompt test asserting that workflows/crane.md contains:

  • ci: trigger checks
  • unless it is the only new commit

If summary generation becomes code-backed, add table tests for:

  • one substantive commit
  • trigger commit plus substantive commit
  • trigger commit only
  • multiple substantive commits plus trigger commit

Acceptance criteria

  • Crane PR comments and issue comments do not present CI trigger commits as the migration change.
  • Process-only commits can still be linked when they are genuinely the only commit.
  • The behavior is documented and guarded by tests.

Provenance

This came from githubnext/apm migration review, where maintainers needed comments to explain the new accepted Crane commit, not a CI wake-up commit.

Lenguaje dominante
Python
Estrellas
10
Forks
0
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 githubnext/crane

Todos los issues de githubnext/crane

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.