Feature request: Lock remote reusable workflow calls (jobs.<id>.uses)

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

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

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
25/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, go
Lĩnh vực
ci-cd, cli

Hướng nghiên cứu

Start in ExtractActionRefs, where job-level uses: values go to parserlock.ParseActionRef, which returns nil for .github/workflows/ paths and drops them silently. Check whether ParseReusableWorkflowRef in the actions-lockfile dependency can supply the owner, repo, path and ref. Done means either the reusable call is resolved and locked, or --verify reports it as unlocked. The maintainer closed #129 against this, so confirm the approach with them first.

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

Mô tả

area:docs area:reusable-workflows bug feature-request

Summary

gh actions-lock does not lock remote reusable workflow calls (jobs.<id>.uses: owner/repo/.github/workflows/<file>.yml@ref). It skips them without a finding, so a workflow whose only external ref is a reusable workflow is recorded as [] and --verify passes.

The lockfile docs say a lockfile pins "every action (including transitive dependencies) and reusable workflow your workflows depend on". The CLI does not do this at the moment.

Based on this comment https://github.com/github/gh-actions-lock/issues/129#issuecomment-6195549413 there seems to be no immediate plan to support this, but I think it is still valuable to track this. As the activity stream of that PR shows quite an interest of the community for such a feature.

This part is generated by Opus 5.5 based on the debugging session I had with it:

Reproduction

gh actions-lock v0.2.0, with this workflow:

# .github/workflows/osv.yml
on: pull_request
jobs:
  scan-pr:
    uses: google/osv-scanner-action/.github/workflows/[email protected]

$ gh actions-lock --no-interactive
$ gh actions-lock --verify
All N workflows valid

# .github/workflows/actions.lock
workflows:
    .github/workflows/osv.yml: []

Expected: the call is resolved and locked like a step-level action, e.g. google/[email protected] with its commit SHA. Alternatively, --verify reports it as unlocked.

Actual: the ref is dropped and the tag stays unpinned with no warning.

Cause

ExtractActionRefs passes job-level uses: values to parserlock.ParseActionRef, which returns nil for any path under .github/workflows/. The nil result is discarded. actions-lockfile already provides ParseReusableWorkflowRef, but gh-actions-lock does not call it.

Why it matters

  • Teams moving to the lockfile change step refs to tags and let the lockfile hold the SHAs. Reusable workflow calls cannot follow that pattern, so they must stay SHA-pinned in YAML. Workflows then mix two pinning styles, and tools such as Renovate, Dependabot and zizmor need different rules for each.
  • If someone converts a reusable workflow call to a tag, assuming the lockfile covers it, nothing pins it. --verify still passes, so the gap is not visible, even though it is documented.

Request

Please lock remote reusable workflow refs at job level, resolved to the commit of the repository that defines them. Their own action dependencies would stay covered by that repository's lockfile, as the docs describe. If this is out of scope, --verify and --no-fix should at least emit a finding for unlocked job-level refs, and the README Limitations section should mention it.

Related

  • #129: closed with "we don't plan to pin job-level uses at this time"
  • #161: open community PR, "Track reusable workflow calls in lock coverage"
  • #169: SHA-pinning policy and reusable workflows (fixed on the backend)
Ngôn ngữ chính
Go
Star
295
Fork
21
Merge trung bình
1 ngày 3 giờ
Pull request đã merge (30 ngày)
64

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 github/gh-actions-lock

Tất cả issue của github/gh-actions-lock

Issue tương tự

Thêm issue về Go

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.