Skip to content

Added information on continuing to run workflows #16717

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

Closed
wants to merge 1 commit into from

Conversation

HammyHavoc
Copy link

Why:

I received an email from GitHub warning me that my workflow would be disabled as there hasn't been activity. I clicked through, and it takes me to https://github.com/HammyHavoc/hammyhavoc/actions?query=workflow:%22Latest+blog+post+workflow%22 instead of https://github.com/HammyHavoc/hammyhavoc/actions/workflows/blog-post-workflow.yml?query=workflow%3A%22Latest+blog+post+workflow%22, thus the Continue running workflow option doesn't appear. I also clicked Learn More in the email, and the documentation didn't explain this.

What's being changed:

I've added the information to prevent others from wasting 15m+ trying to figure this out. This isn't the first time this has happened to me.

Check off the following:

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

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

I received an email from GitHub warning me that my workflow would be disabled as there hasn't been activity. I clicked through, and it takes me to https://github.com/HammyHavoc/hammyhavoc/actions?query=workflow:%22Latest+blog+post+workflow%22 instead of https://github.com/HammyHavoc/hammyhavoc/actions/workflows/blog-post-workflow.yml?query=workflow%3A%22Latest+blog+post+workflow%22, thus the `Continue running workflow` option doesn't appear. I also clicked `Learn More` in the email, and the documentation didn't explain this, thus I've added the information to prevent others from wasting 15m+ trying to figure this out.
@welcome
Copy link

welcome bot commented Mar 31, 2022

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 Mar 31, 2022
@ramyaparimi ramyaparimi 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 needs SME This proposal needs review from a subject matter expert and removed triage Do not begin working on this issue until triaged by the team labels Apr 1, 2022
@ramyaparimi
Copy link
Contributor

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

@@ -1 +1 @@
To prevent unnecessary workflow runs, scheduled workflows may be disabled automatically. When a public repository is forked, scheduled workflows are disabled by default. In a public repository, scheduled workflows are automatically disabled when no repository activity has occurred in 60 days.
To prevent unnecessary workflow runs, scheduled workflows may be disabled automatically. When a public repository is forked, scheduled workflows are disabled by default. In a public repository, scheduled workflows are automatically disabled when no repository activity has occurred in 60 days. You can continue to run scheduled workflows without repository activity by visiting the workflow's page and clicking `Continue running workflow`.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm generally +1 on documenting this, it seems useful. I'm not sure that it should be in the reusable, though, it seems like it should only be a part of the disabling-and-enabling-a-workflow page. It would fit in nicely there and breaking it out of the reusable allows us to expand the instructions so that it's a little more verbose and step-by-step than just "[visit] the workflow's page".

I wonder if the docs team has any thoughts here...

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree with @ethomson . This reusable is also used in the "Usage limits, billing, and administration" article, but the added info is really only relevant to the "Disabling and enabling a workflow" article. Adding this info to the "Disabling and enabling a workflow" article (content/actions/managing-workflow-runs/disabling-and-enabling-a-workflow.md) instead makes sense.

(To help orient you in that file: this reusable is referred to as{% data reusables.actions.scheduled-workflows-disabled %}. You can find more info about reusables here.)

I also agree that we could give users a bit more context. Since this is almost identical to enabling a workflow, maybe we can can say something like:

To continue to run a scheduled workflow that was disabled due to no repository activity, follow the steps under [Enabling a workflow](#enabling-a-workflow) and click `Continue running workflow`.

Alternatively, we could add a new section that is similar to the Enabling a workflow section

@ramyaparimi ramyaparimi added SME reviewed An SME has reviewed this issue/PR and removed needs SME This proposal needs review from a subject matter expert labels Apr 7, 2022
@janiceilene
Copy link
Contributor

👋 @HammyHavoc I'm going to close this up since there's been no activity for a while, but please feel free to reopen if you'd like to address the review comments in #16717 (comment) 💖

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 SME reviewed An SME has reviewed this issue/PR waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants