Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Specify allowed contexts in jobs.<job_id>.services.<service_id>.image #33747

Closed
wants to merge 4 commits into from

Conversation

piotrekkr
Copy link

@piotrekkr piotrekkr commented Jun 27, 2024

Why:

Documentation does not mention if and which context variable can be used in jobs.<job_id>.services.<service_id>.image. From my tests a subset of contexts can be used and those are: github, matrix, strategy, needs, vars and inputs.

Unfortunately, using env context is not possible. Not sure why that is. Anyhow, specifying allowed contexts in docs would be helpful when writing workflows.

I've also changed conditional service creation example because it contained invalid example that was using options context which does not exist.

What's being changed (if available, include any code snippets, screenshots, or gifs):

Added a note about allowed contexts and fixed example conditional service creation.

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

Documentation does not mention if and which context variable can be used in `jobs.<job_id>.services.<service_id>.image`. From my tests a subset of contexts can be used and those are: `github`, `matrix`, `strategy`, `needs`, `vars` and inputs. 

Unfortunately, using `env` context is not possible. Not sure why but specifying allowed contexs in docs would be helpful when writing workflows. 

I've also changed conditional service creation example because it contained invalid example that was using `options` context which does not exist.
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jun 27, 2024
Copy link
Contributor

github-actions bot commented Jun 27, 2024

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
actions/using-workflows/workflow-syntax-for-github-actions.md fpt
ghec
ghes@ 3.13 3.12 3.11 3.10 3.9
fpt
ghec
ghes@ 3.13 3.12 3.11 3.10 3.9

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team actions This issue or pull request should be reviewed by the docs actions team waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Jun 27, 2024
@nguyenalex836
Copy link
Contributor

@piotrekkr Thanks so much for opening a PR! I'll get this triaged for review ✨

@hubwriter
Copy link
Contributor

@piotrekkr - Thanks for raising this PR. I've asked the development team to confirm your changes before we go ahead and merge this.

…ions.md

Co-authored-by: hubwriter <hubwriter@github.com>
@piotrekkr
Copy link
Author

Closing this pull request because there is a list of available contexts in each configuration sections here.

@piotrekkr piotrekkr closed this Jul 9, 2024
@piotrekkr piotrekkr deleted the patch-2 branch July 9, 2024 20:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review
4 participants