Skip to content
This repository was archived by the owner on Sep 1, 2022. It is now read-only.

Help learner when workflows don't run #6

Merged
merged 7 commits into from
Apr 16, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ template:
# Repo artifacts
# repositoryUrl
# actionsUrl
# workflowEditUrl
# branchSettingsUrl
# 1. (Issue) Start here!
# welcomeIssueUrl
# welcomeIssueNumber
Expand Down Expand Up @@ -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: >-
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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.
Copy link
Member Author

Choose a reason for hiding this comment

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

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?

Copy link

Choose a reason for hiding this comment

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

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!

Copy link
Member Author

Choose a reason for hiding this comment

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

What do you think @mattdavis0351?

Copy link
Contributor

Choose a reason for hiding this comment

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

@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 🤷‍♂️

Copy link
Contributor

@brianamarie brianamarie Apr 16, 2020

Choose a reason for hiding this comment

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

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


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!
Expand Down
4 changes: 2 additions & 2 deletions responses/00_explain-gh-script.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down
11 changes: 11 additions & 0 deletions responses/02_workflow-triggered.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
11 changes: 11 additions & 0 deletions responses/05_workflow-triggered.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy