Merge pull request #6 from githubtraining/troubleshoot-action

Help learner when workflows don't run

Author: hectorsector

config.yml

@@ -15,6 +15,8 @@ template:
 # Repo artifacts
 #       repositoryUrl
 #       actionsUrl
+#       workflowEditUrl
+#       branchSettingsUrl
 # 1. (Issue) Start here!
 #       welcomeIssueUrl
 #       welcomeIssueNumber
@@ -42,6 +44,8 @@ before:
     store:
       repositoryUrl: '{{ payload.repository.html_url }}'
       actionsUrl: '{{ payload.repository.html_url }}/actions'
+      workflowEditUrl: '{{ payload.repository.html_url }}/edit/master/.github/workflows/my-workflow.yml'
+      branchSettingsUrl: '{{ payload.repository.html_url }}/settings/branches'
   - type: createProjectBoard
     name: Learning Lab Project Board
     description: >-
@@ -131,7 +135,7 @@ steps:
           - type: respond
             with: e-generic.md
             data:
-              expected: merge pull request '{{ store.firstPullNumber }}'
+              expected: 'merge pull request #{{ store.firstPullNumber }}'
       - type: createIssue
         title: Create an issue comment with GitHub Script
         body: 02_workflow-triggered.md
@@ -249,7 +253,7 @@ steps:
           - type: respond
             with: e-generic.md
             data:
-              expected: merge pull request '{{ store.secondPullNumber }}'
+              expected: 'merge pull request #{{ store.secondPullNumber }}'
       - type: createIssue
         title: Comment and triage with GitHub Script
         body: 05_workflow-triggered.md
@@ -348,7 +352,7 @@ steps:
           - type: respond
             with: e-generic.md
             data:
-              expected: push a commit to '{{ store.thirdPullNumber }}'
+              expected: 'push a commit to #{{ store.thirdPullNumber }}'
       - type: createReview
         body: 08_merge-workflow.md
         event: APPROVE
@@ -369,7 +373,7 @@ steps:
           - type: respond
             with: e-generic.md
             data:
-              expected: merge pull request '{{ store.thirdPullNumber }}'
+              expected: 'merge pull request #{{ store.thirdPullNumber }}'
       - type: octokit
         action_id: triggerIssue
         method: issues.create
@@ -381,6 +385,17 @@ steps:
 
           Like before, now we have to wait for the workflow to run so that we can see the results.  
 
+          <details>
+            <summary>Workflow not running? Click here for some troubleshooting.</summary>
+
+          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.
+
+          If you need to make changes to your code, remove the [master branch protection]({{ store.branchSettingsUrl }}) and merge your changes into the `master` branch.
+          </details>
+
           ---
 
           I'll respond here once it has completed!

responses/00_explain-gh-script.md

@@ -20,7 +20,7 @@ Okay, that doesn't seem so hard. Now that we know how to do it with Octokit let'
 ```yaml
 - uses: actions/github-script@0.8.0
   with:
-    github-token: ${{secrets.GITHUB_TOKEN}}
+    github-token: {% raw %}${{secrets.GITHUB_TOKEN}}{% endraw %}
     script: |
     github.issues.createComment({
         issue_number: context.issue.number,
@@ -51,7 +51,7 @@ Again, that's not too hard at all. Now let's do the same thing, only using the G
 ```yml
 - uses: actions/github-script@0.8.0
   with:
-    github-token: ${{secrets.GITHUB_TOKEN}}
+    github-token: {% raw %}${{secrets.GITHUB_TOKEN}}{% endraw %}
     script: |
     github.pull.create({
         repo: github.context.repo.repo,

responses/02_workflow-triggered.md

@@ -14,6 +14,17 @@ This means that every time an issue gets opened in this repository the GitHub Sc
 
 You should expect to see the result right here in this issue!
 
+<details>
+  <summary>Workflow not running? Click here for some troubleshooting.</summary>
+
+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.
+
+If you need to make changes to your code, remove the [master branch protection]({{ store.branchSettingsUrl }}) and merge your changes into the `master` branch.
+</details>
+
 ---
 
 I'll respond in this issue after your workflow runs!

responses/05_workflow-triggered.md

@@ -2,6 +2,17 @@
 
 Now that your updates have been merged and we've triggered the workflow we should see our workflow begin helping us automate the triage of new issues.
 
+<details>
+  <summary>Workflow not running? Click here for some troubleshooting.</summary>
+
+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.
+
+If you need to make changes to your code, remove the [master branch protection]({{ store.branchSettingsUrl }}) and merge your changes into the `master` branch.
+</details>
+
 ---
 
 I'll respond once your workflow has completed!