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

Đang mở
  • Có gì không ổn?
#84 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
74/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
github-actions, shell, yaml
Lĩnh vực
ci-cd, devops, tooling

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
153
Fork
44
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của tailscale/gitops-acl-action

Tất cả issue của tailscale/gitops-acl-action

Issue tương tự

Thêm issue về DevOps

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.