Update reusing-workflows.md#23824
Conversation
Consider `version private-actions` when selecting "any" or "either" for the section on Access to reusable workflows
|
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. |
|
@tvalenta Thank you for opening a PR and linking it to your issue! ✨ I'll get this triaged for review! ⚡ |
felicitymay
left a comment
There was a problem hiding this comment.
@tvalenta - many thanks for raising an issue for this grammar bug and for your suggested fix ✨
It looks as if users will now see at least 3 bullet points in all versions of the documentation, so I think we can use a simpler fix. I'm going to commit my suggestion, and then we should be able to merge this PR and close the issue that you raised 🚀
| ## Access to reusable workflows | ||
|
|
||
| A reusable workflow can be used by another workflow if {% ifversion ghes or ghec or ghae %}any{% else %}either{% endif %} of the following is true: | ||
| A reusable workflow can be used by another workflow if {% ifversion private-actions or ghes or ghec or ghae %}any{% else %}either{% endif %} of the following is true: |
There was a problem hiding this comment.
It looks as if users will always see at least 3 bullets here so we can remove this condition altogether.
| A reusable workflow can be used by another workflow if {% ifversion private-actions or ghes or ghec or ghae %}any{% else %}either{% endif %} of the following is true: | |
| A reusable workflow can be used by another workflow if any of the following is true: |
There was a problem hiding this comment.
Hi @felicitymay . Your change is definitely more reasonable. For my own edification, is private-actions now always true? Is it possible for ghes or ghec or ghae to be true, but private-actions disabled?
There was a problem hiding this comment.
Hi @tvalenta - private-actions is an example of a docs "feature flag" that we use to simplify conditions for the different versions of GitHub. Any content within a {% ifversion private-actions %} condition is shown for these versions of the product: https://github.com/github/docs/blob/main/data/features/private-actions.yml.
This feature flag is used to control the display of the final bullet. We have a situation where:
- Bullets 1 and 2 are shown for all versions of GitHub.
- Bullet 3 is shown only for enterprise versions of GitHub.
- Bullet 4 is shown for Free, Pro, Team plans, GitHub Enterprise Cloud, and GitHub Enterprise Server 3.8+ (as defined by the
private-actionsflag.
Consequently, all versions of this article will include at least three bullets. However, that wasn't true for Free, Pro, Team plans until bullet 4 was added in December. So it looks as if we overlooked this in that update.
If you're interested, you can find out more about use of conditions and feature flags in our docs here: liquid helpers and featues/README.
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 changesYou 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.
fpt: Free, Pro, Team |
|
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 ⚡ |
This comment was marked as spam.
This comment was marked as spam.
This reverts commit 9a70d55.
Consider
version private-actionswhen selecting "any" or "either" for the section on Access to reusable workflowsWhy:
Closes #23823 23823
What's being changed (if available, include any code snippets, screenshots, or gifs):
This adds
private-actionsto the list of versions considered when creating a list of assertions for which one must be true in order to reuse workflows.Check off the following: