Skip to content

Update reusing-workflows.md#23824

Merged
felicitymay merged 3 commits intogithub:mainfrom
tvalenta:patch-1
Feb 17, 2023
Merged

Update reusing-workflows.md#23824
felicitymay merged 3 commits intogithub:mainfrom
tvalenta:patch-1

Conversation

@tvalenta
Copy link
Copy Markdown
Contributor

@tvalenta tvalenta commented Feb 9, 2023

Consider version private-actions when selecting "any" or "either" for the section on Access to reusable workflows

Why:

Closes #23823 23823

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

This adds private-actions to 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:

  • I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • For content changes, I have completed the self-review checklist.

Consider `version private-actions` when selecting "any" or "either" for the section on Access to reusable workflows
@welcome
Copy link
Copy Markdown

welcome Bot commented Feb 9, 2023

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.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Feb 9, 2023
@cmwilson21 cmwilson21 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 Feb 10, 2023
@cmwilson21
Copy link
Copy Markdown
Contributor

@tvalenta Thank you for opening a PR and linking it to your issue! ✨

I'll get this triaged for review! ⚡

felicitymay
felicitymay previously approved these changes Feb 17, 2023
Copy link
Copy Markdown
Contributor

@felicitymay felicitymay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks as if users will always see at least 3 bullets here so we can remove this condition altogether.

Suggested change
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:

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-actions flag.

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.

@github-actions
Copy link
Copy Markdown
Contributor

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/reusing-workflows.md fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae
fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae

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

@felicitymay felicitymay merged commit 9a70d55 into github:main Feb 17, 2023
@felicitymay felicitymay added ready to merge This pull request is ready to merge and removed waiting for review Issue/PR is waiting for a writer's review labels Feb 17, 2023
@github-actions
Copy link
Copy Markdown
Contributor

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

@erdenerrallas19

This comment was marked as spam.

NewKaliLuv added a commit to NewKaliLuv/docs that referenced this pull request Oct 14, 2023
Austinlynn1986

This comment was marked as spam.

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 ready to merge This pull request is ready to merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Grammatical error in docs for reusable workflows

6 participants