Help learner when workflows don't run #6
Conversation
Your draft course version was created!You can edit it using the Course Builder UI! |
| This pull request will create a new major version of your course; changes to the title and other metadata will only apply to the course once the pull request is merged! |
There was a problem hiding this comment.
@hectorsector I would suggest adding another line to the troubleshooting. I had to add another issue to trigger the workflow after i fixed my code. I'm not sure the learner would realize that.
I'm not sure I understand this one, can you elaborate @lmkeston? |
@hectorsector here are the steps I followed:
Does that make sense? |
| Try the following troubleshooting steps: | ||
| 1. Click on the [Actions tab]({{ store.actionsUrl }}) to see the status of your workflow run. See [Managing a workflow run](https://help.github.com/en/actions/configuring-and-managing-workflows/managing-a-workflow-run) on GitHub Help for more information. | ||
| 1. Edit your [workflow file]( {{ store.workflowEditUrl }}) and look for errors in the linter built into the browser. | ||
| 1. Look for the [workflow trigger](https://help.github.com/en/actions/reference/events-that-trigger-workflows) and ensure you are performing an action that triggers that workflow. |
There was a problem hiding this comment.
however the workflow still doesn't run because it is triggered by the opening of an issue. so i had to create another issue
It makes sense now, thank you @lmkeston! Does this troubleshooting step not capture that?
There was a problem hiding this comment.
it does, but i'm not sure learners would realize that the issue that was just added won't trigger it after fixing the code, that a new issue is required to unblock. your call @hectorsector!
There was a problem hiding this comment.
What do you think @mattdavis0351?
There was a problem hiding this comment.
@hectorsector it seems as though it captures it in the instructions, and both of you agree on that. Let's run it like this to do some testing. If we see this come up often in the forum, then we can adjust the wording.
I'd hate to let a hypothetical understanding of instructions derail shipping this. Let' ship to learn 🤷♂️
There was a problem hiding this comment.
Yay! Unsolicited feedback from me, let's ship to learn!
PS none of my gifs are working so here's a link to the one I'm trying to post: https://media.giphy.com/media/l09y7RIxj7X12S24gN/giphy.gif
This PR adds some troubleshooting steps for the learner in case there are problems with their workflow.