Add --format github for inline workflow annotations

Đang mở Phù hợp với người mới
#123 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 2 ngày

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

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
85/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
typescript
Lĩnh vực
ci-cd

Hướng nghiên cứu

Bắt đầu tại src/cli.ts, ở FORMATS và render, sau đó đọc src/sarif.ts để tìm hiểu cách xử lý đường dẫn và test/cli.test.ts để xem phạm vi kiểm thử CLI hiện có. Thêm đầu ra lệnh workflow của GitHub được mô tả trong issue, bao gồm ánh xạ mức độ nghiêm trọng và xử lý escape, rồi chạy npm run build \u0026\u0026 npm test. Hoàn tất khi mỗi phát hiện được hiển thị dưới dạng một chú thích hợp lệ với đường dẫn tương đối theo cwd.

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

Mô tả

enhancement good first issue severity: medium

Summary

Add --format github that prints GitHub Actions workflow-command annotations, so findings show inline on PRs without SARIF upload. Code scanning, which SARIF upload needs, is not available on private repos without GitHub Advanced Security.

Where

  • src/cli.ts:18 (FORMATS = ["json", "pretty", "sarif"])
  • src/cli.ts:218-230 (render)

Proposal

Print one line per finding: ::error file=<path>,line=<l>,col=<c>,title=<ruleId>::<message>, mapping warning to ::warning and info to ::notice. Make the path relative to the cwd, as SARIF does. Escape %, \r, \n (and ,/: in properties) as the workflow-command spec requires.

Who benefits

Every GitHub CI user, with zero extra setup.

Getting started

  • Relevant files: src/cli.ts, src/sarif.ts (for the path handling), test/cli.test.ts
  • How to run tests: npm run build && npm test

Filed by repo-audit/full-audit at e836036. Severity: medium. Effort: S. audit-key: enhancement|src/cli.ts|FORMATS

Ngôn ngữ chính
TypeScript
Star
0
Fork
6
Merge trung bình
1 ngày 21 giờ
Pull request đã merge (30 ngày)
8

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

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 TMHSDigital/godot-correctness-mcp

Tất cả issue của TMHSDigital/godot-correctness-mcp

Issue tương tự

Thêm issue về TypeScript

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.