github / github/docs

Inconsistent allowed contexts for reusable workflow secrets/inputs

オープン
#40,391 コメント 7 件 リアクション 0 件 担当者 0 名 GitHub で見る
content github_actions never-stale
主要言語
TypeScript
スター
20.8k
フォーク
68.7k
平均マージ
12時間 24分
マージ済み PR(30日)
105

説明

### Code of Conduct

- [x] I have read and agree to the GitHub Docs project's [Code of Conduct](https://github.com/github/docs/blob/main/.github/CODE_OF_CONDUCT.md)

### 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/reference/workflows-and-actions/reusable-workflows

### What part(s) of the article would you like to see updated?

I have found inconsistencies between the `actions/reference/workflows-and-actions/contexts.md` and the `actions/reference/workflows-and-actions/reusable-workflows.md` pages.

The `reusable-workflows.md` page defines contexts for `jobs..secrets.` and `jobs..with.` like so:

```markdown
## `jobs..with.`

[...]

Allowed expression contexts: `github`, and `needs`.
```

```markdown
## `jobs..secrets.`

[...]

Allowed expression contexts: `github`, `needs`, and `secrets`.
```

~~This seems to match observed behavior that the following using `vars`, using a reusable workflow that requires a secret, does not work:~~ _After testing in a different and cleaner environment,_ this actually does not match the observed behavior, as the following using `vars`, using a reusable workflow that requires a secret, does work:

```yml
jobs:
job:
uses: job.yml
secrets:
MY_SECRET: ${{ vars.MY_SECRET }}
```

Indeed, the `contexts.md` page defines these contexts like so:

```markdown
| `jobs..secrets.` | `github, needs, strategy, matrix, secrets, inputs, vars` | None |
| `jobs..with.` | `github, needs, strategy, matrix, inputs, vars` | None |
```

~~So I would have expected `vars` to work in this context, but it does not.~~

Also while we are at it, note the workflow keys are not consistent: `secrets_id` vs `secret_id`, and `with_id` vs `input_id`.

Therefore I would suggest to:
- Rename the workflow keys in the `contexts.md` page to match those in the `reusable-workflows.md` page,
- Update the "allowed expression contexts" in the `reusable-workflows.md` page to match what is described in the `contexts.md` page.

### Additional information

_No response_

コントリビューションガイド

コントリビューションガイドを開く

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。