feat: Expose gitops-pusher result as step outputs (e.g. for PR comments)

Abierto
  • ¿Algo no está bien?
#84 0 comentarios 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
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
github-actions, shell, yaml
Área
ci-cd, devops, tooling

Línea de trabajo

Start in action.yml, especially the Gitops pusher step and the action's existing outputs and execution flow. Exercise the action: test path with a successful and failing policy check, then verify the declared outcome, output, and changed values are available to later steps while failures still produce a non-zero status.

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

Descripción

Summary

Expose the result of gitops-pusher as step outputs so a later step in the workflow can report it, for example by posting a comment on the pull request.

Motivation

When action: test runs on a pull request, the only place to see why it failed is the job log. For example:

test(s) failed

For user tag:example:
Errors found:
- [acl test error]: address "tag:server:22" (protocol "tcp"): want: Drop, got: Accept

exit status 1

It would be much easier to review policy changes if that message could be posted to the PR automatically. Right now the action gives a later step nothing to work with:

  • It defines no outputs, so later steps can't read the result or the error text.
  • The output from gitops-pusher only goes to the job log.

To get a PR comment today, I had to stop using the action for PR checks and copy what it does into my own workflow: set up Go, pin the same gitops-pusher commit, run it with | tee, and fetch the live policy from the API myself. I'd rather keep using the action and keep getting its updates.

Proposed change

Add outputs to the action, for example:

Output Description
outcome success or failure from gitops-pusher
output Everything gitops-pusher printed (stdout and stderr), or at least the error part
changed true if the local policy differs from the live policy (control vs. local ETag)

A diff between the live policy and the local file would also be helpful as an output, so reviewers can see exactly what merging will change. If that doesn't fit this action, the three outputs above cover the main need.

With these outputs, a workflow could do this:

- name: Test ACL
  id: test-acl
  uses: tailscale/gitops-acl-action@v1
  continue-on-error: true
  with:
    oauth-client-id: ${{ secrets.TS_OAUTH_ID }}
    oauth-secret: ${{ secrets.TS_OAUTH_SECRET }}
    tailnet: ${{ secrets.TS_TAILNET }}
    action: test

- name: Comment on PR
  if: always() && github.event_name == 'pull_request'
  env:
    GH_TOKEN: ${{ github.token }}
    OUTCOME: ${{ steps.test-acl.outputs.outcome }}
    OUTPUT: ${{ steps.test-acl.outputs.output }}
  run: |
    # build a comment from $OUTCOME / $OUTPUT and post it with `gh pr comment`

Implementation notes

Changes to the Gitops pusher step in action.yml:

  • Run gitops-pusher with 2>&1 | tee so its output still appears in the log.
  • Keep its exit code, then write the output to $GITHUB_OUTPUT using the multiline heredoc syntax.
  • Declare the new values under outputs: in action.yml.

The step should still exit non-zero when gitops-pusher fails, so existing workflows behave the same.

Optionally, the action could write the same output to $GITHUB_STEP_SUMMARY. That would show failures on the run summary page with no extra workflow setup.

Lenguaje dominante
Sin datos de lenguaje
Estrellas
153
Forks
44
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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 tailscale/gitops-acl-action

Todos los issues de tailscale/gitops-acl-action

Issues similares

Más issues de DevOps

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.