docs icon indicating copy to clipboard operation
docs copied to clipboard

workflow-syntax-for-github-actions.md: services.image: document empty image

Open ronjouch opened this issue 1 year ago â€ĸ 4 comments

Why:

Closes: N/A

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

This is a follow-up of GH Actions community discussion #109389 - Conditional GHA jobs services and documents this undocumented solution that works great 🙂.

In the absence of jobs.<job_id>.services.<service_id>.if, this '' behavior is extremely useful and I would have loved to find it in the doc.

Here it is! Preview deployment:

preview-deploy-okay

Check off the following:

  • [x] 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.
  • [x] For content changes, I have completed the self-review checklist.

ronjouch avatar Feb 21 '24 14:02 ronjouch

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Feb 21 '24 14:02 welcome[bot]

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.12 3.11 3.10 3.9 3.8
fpt
ghec
ghes@ 3.12 3.11 3.10 3.9 3.8

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

github-actions[bot] avatar Feb 21 '24 14:02 github-actions[bot]

@ reviewers: preview deployment okay!

preview-deploy-okay

ronjouch avatar Feb 21 '24 14:02 ronjouch

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

nguyenalex836 avatar Feb 21 '24 17:02 nguyenalex836

@ronjouch Hello, and thank you for patience while our team reviewed! 👋 After review, our team assessed this seems to be a very specific case. We are unable to cover every edge case in our documentations, and will not be able to add this update 💛

I'm going to go ahead and close this PR now. Thank you for your interest in improving the docs! ✨

nguyenalex836 avatar Mar 11 '24 18:03 nguyenalex836

After review, our team assessed this seems to be a very specific case. We are unable to cover every edge case in our documentations, and will not be able to add this update

@nguyenalex836 I beg to differ. This is not "edge case" land to me, it's the only way I was able to make my service conditional. Without lucking out on getting the tip about '' from the community, I'd have had no idea this was feasible 😕.

I'd love if GHA had explicit support for conditional services, but in doesn't. Until it does, please reconsider documenting this.

ronjouch avatar Mar 11 '24 18:03 ronjouch

Hey @ronjouch, thank you for responding to us. We've shown your response to the team, and they've agreed that it is okay to document this functionality. We updated the text to match our style guide, and will get this PR merged!

Thank you for your care while contributing to GitHub docs. 💛

SiaraMist avatar Mar 11 '24 23:03 SiaraMist

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues :zap:

github-actions[bot] avatar Mar 11 '24 23:03 github-actions[bot]

Hey @ronjouch, thank you for responding to us. We've shown your response to the team, and they've agreed that it is okay to document this functionality. We updated the text to match our style guide, and will get this PR merged! Thank you for your care while contributing to GitHub docs. 💛

@SiaraMist thanks for listening and reconsidering! Confirmed shipped.

ronjouch avatar Mar 12 '24 00:03 ronjouch