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

Aperta
  • Qualcosa non va?
#84 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
74/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
github-actions, shell, yaml
Ambito
ci-cd, devops, tooling

Direzione di ricerca

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.

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

Descrizione

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.

Lingua principale
Nessun dato sulla lingua
Stelle
153
Fork
44
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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

Tutte le issue di tailscale/gitops-acl-action

Issue simili

Altre issue su DevOps

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.