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

未关闭
  • 哪里不对？
#179 2 条评论 6 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
25/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
github-actions, go
领域
ci-cd, cli

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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)
主要语言
Go
星标
295
派生
21
平均合并
1 天 3 小时
30 天内合并 PR
64

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

github/gh-actions-lock 的其他 Issue

查看 github/gh-actions-lock 的全部 Issue

相似的 Issue

更多 Go Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。