Clarify vars context availability in composite actions
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
- #46249 @alok-108 による — マージされずにクローズ
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 74/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- github-actions, typescript
調査の方向性
issueでリンクされているcontextsのリファレンスとcomposite actionsの記事を読み、次にdocsリポジトリでそれらのページがどのように構成されているか確認してください。composite actionが必要とする値は、varsからの値も含めて、inputsを通じて渡すべきであることを明確にしてください。issueの例を使って、両方のページで説明に一貫性があるか確認してください。
索引モデルが issue の本文から書いたものです。
説明
Code of Conduct
- I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/actions/reference/workflows-and-actions/contexts
https://docs.github.com/en/actions/sharing-automations/creating-actions/creating-a-composite-action
What part(s) of the article would you like to see updated?
The documentation is unclear about whether the vars context is available inside composite actions.
The contexts reference lists vars as an available context, which can reasonably lead users to assume that this works inside a composite action:
runs:
using: composite
steps:
- shell: bash
run: echo "${{ vars.AWS_REGION }}"
However, the Composite Actions ADR states:
"Composite actions should leverage inputs to get values they need, they will not have full access to the context objects."
There is also an implementation detail documented by a runner collaborator in actions/runner#4311: variables are filtered based on references made directly in the calling job, so a vars reference used only inside a composite action may not be available to the runner.
Could the composite actions documentation explicitly clarify that values required by a composite action should be passed through inputs, including values originating from vars?
For example:
- uses: ./my-action
with:
region: ${{ vars.AWS_REGION }}
and then inside the composite action:
${{ inputs.region }}
This would make the relationship between the general contexts documentation and the more limited context availability of composite actions clearer.
Thanks
Additional information
No response
- 主要言語
- TypeScript
- スター
- 21k
- フォーク
- 69k
- 平均マージ
- 9時間 42分
- マージ済み PR(30日)
- 110
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
github/docs のほかの issue
-
Broken page layout on non-English translated versions of "Models and pricing for GitHub Copilot"対応中かも @alok-108 が今日担当しました。 オープンcontent localization
難易度 2/5 1〜3時間 初心者へのやさしさ 69/100
github/docs#46269 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
Should mention you need enterprise in order to get insights対応中かも @vrushabhakamdi-dev が 3 日前に担当しました。 オープンcontent driver persona
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
github/docs#46242 · コメント 3 件 ·
メンテナーはふだん 1 日以内に返信
-
Dependabot docs disagree on when the ecosystem label is added, and on its name (github-actions vs github_actions)対応中かも @travisfortney が 1 日前に担当しました。 オープンbuilder persona help wanted
難易度 1/5 1〜3時間 初心者へのやさしさ 83/100
github/docs#46230 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
Update model availability under data residency page再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープンcontent driver persona
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
mention permissions required to jump the queue再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープンbuilder persona content
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
github/docs#46190 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
NaturalIntelligence/fast-xml-parser#890 · コメント 1 件 ·
メンテナーはふだん 3 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
zsviczian/obsidian-excalidraw-plugin#3000 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
pnpm/get.pnpm.io#68 ·
-
[BUG] Cloudflare KV binding 模式下 kvDriver.list() 沿用 EdgeOne 语义,字段名不匹配导致 key 格式下初始化 500 并耗尽 list 配额対応中かも @wumingzhinu が今日担当しました。 オープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
OpenListTeam/OpenList-Worker#125 ·
メンテナーはふだん 2 日以内に返信
-
Android (vision-camera-location): HybridLocationManager never quits its HandlerThread on disposeオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
margelo/react-native-vision-camera#4217 ·
メンテナーはふだん 4 日以内に返信