Document the I understand my workflows screen
#15761
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
needs SME
This proposal needs review from a subject matter expert
SME stale
The request for an SME has staled
waiting for review
Issue/PR is waiting for a writer's review
Projects
Comments
jsoref
added
the
content
github-actions
bot
added
the
triage
ramyaparimi
added
actions
|
@jsoref |
ramyaparimi
added
the
needs SME
|
This is a gentle bump for the docs team that this issue is waiting for technical review. |
|
@jsoref |
EliahKagan
added a commit
to EliahKagan/EmbeddingScratchwork
that referenced
this issue
Mar 15, 2023
My previous wording had effectively suggested that the inherited CI workflows would be enabled automatically in a fork, which is not the case. This commit addresses how to enable them in a a forked repository's Actions tab. I don't want to put an enormous amount of what is effectively general GitHub documentation in the readme, since the readme is already verging on being excessively long. But this is unfortunately not well documented in the GitHub docs. (See github/docs#15761, which was closed as completed, but appears actually to have been declined.) In the Actions tab of a newly created fork, this message is shown: > Workflows aren’t being run on this forked repository > > Because this repository contained workflow files when it was > forked, we have disabled them from running on this fork. Make > sure you understand the configured workflows and their expected > usage before enabling Actions on this repository. There is a button "I understand my workflows, go ahead and enable them" as well as a link "View the workflows directory". I've largely not documented the details of this; I note them in this commit message so it's clear what the changes in this commit refer to in case the GitHub user interface changes in the future, and for insight. Instead, I've linked to two pages where they are discussed: the GitHub docs bug report, and documentation for an unrelated project. These sources are imperfect, since neither is intended as *general* documentation, and maybe the information should be reproduced in our readme, but for now I think this may be enough.
dmvassallo
added a commit
to dmvassallo/EmbeddingScratchwork
that referenced
this issue
Mar 22, 2023
* Document how to enable workflows My previous wording had effectively suggested that the inherited CI workflows would be enabled automatically in a fork, which is not the case. This commit addresses how to enable them in a a forked repository's Actions tab. I don't want to put an enormous amount of what is effectively general GitHub documentation in the readme, since the readme is already verging on being excessively long. But this is unfortunately not well documented in the GitHub docs. (See github/docs#15761, which was closed as completed, but appears actually to have been declined.) In the Actions tab of a newly created fork, this message is shown: > Workflows aren’t being run on this forked repository > > Because this repository contained workflow files when it was > forked, we have disabled them from running on this fork. Make > sure you understand the configured workflows and their expected > usage before enabling Actions on this repository. There is a button "I understand my workflows, go ahead and enable them" as well as a link "View the workflows directory". I've largely not documented the details of this; I note them in this commit message so it's clear what the changes in this commit refer to in case the GitHub user interface changes in the future, and for insight. Instead, I've linked to two pages where they are discussed: the GitHub docs bug report, and documentation for an unrelated project. These sources are imperfect, since neither is intended as *general* documentation, and maybe the information should be reproduced in our readme, but for now I think this may be enough. * Fix line length in README --------- Co-authored-by: David Vassallo <vassallo.davidm@gmail.com>
|
Since it looks like everyone who wants to refer to this screen just links to this issue in the absence of real documentation, I want to flag this bug I just reported, where certain pushes that touch files in |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
and others
Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions
https://docs.github.com/en/actions/managing-workflow-runs
What part(s) of the article would you like to see updated?
Something should describe this page that users will see, explain what it means, and link to pages that actually talk about the security ramifications of enabling workflows.
It should also explain how to get to this screen. And it could be helpful if it explains "If your fork predates the introduction of workflows in the upstream, instead of seeing this screen, you may see the
Get started with GitHub Actionsscreen, in order to get the existing upstream workflows, you'll need to usefetch upstreamfeature".Expected outcome: I should be able to link to a page from my documentation in order to help a user of a fork understand how to enable workflows in order to explain how they can start using my workflow (which is present in the upstream).
Additional information
Fwiw, while you're adding documentation, you could also mention:
-- Alternatively, the message itself could be changed to not provide a misleading statement...
The text was updated successfully, but these errors were encountered: