Prepare course for release

mattdavis0351 commented 4 years ago

This PR addresses the release checklist for this course. The current progress can be found in the tracking issue.

github-learning-lab[bot] commented 4 years ago

Your draft course version was created!

You can edit it using the Course Builder UI!

github-learning-lab[bot] commented 4 years ago

:red_circle: 16 errors found in the config file.

- Action [2] in [GitHub Actions: Using GitHub Script] does not match the `createIssue` action's schema
  - "store" is not allowed
- "steps[0].link" does not match any of the allowed types
- Action [5] in [Setup a workflow file] does not match the `createReview` action's schema
  - "store" is not allowed
- "steps[1].link" does not match any of the allowed types
- Action [triggerIssue] in [Merge the new workflow into the master branch] does not match the `createIssue` action's schema
  - "store" is not allowed
- "steps[2].link" does not match any of the allowed types
- "steps[3].link" does not match any of the allowed types
- Action [5] in [Modify your workflow file] does not match the `createReview` action's schema
  - "store" is not allowed
- "steps[4].link" does not match any of the allowed types
- Action [triggerIssue] in [Merge the new workflow into the master branch] does not match the `createIssue` action's schema
  - "store" is not allowed
- "steps[5].link" does not match any of the allowed types

github-learning-lab[bot] commented 4 years ago

:red_circle: 16 errors found in the config file.

- Action [2] in [GitHub Actions: Using GitHub Script] does not match the `createIssue` action's schema
  - "store" is not allowed
- "steps[0].link" does not match any of the allowed types
- Action [5] in [Setup a workflow file] does not match the `createReview` action's schema
  - "store" is not allowed
- "steps[1].link" does not match any of the allowed types
- Action [triggerIssue] in [Merge the new workflow into the master branch] does not match the `createIssue` action's schema
  - "store" is not allowed
- "steps[2].link" does not match any of the allowed types
- "steps[3].link" does not match any of the allowed types
- Action [5] in [Modify your workflow file] does not match the `createReview` action's schema
  - "store" is not allowed
- "steps[4].link" does not match any of the allowed types
- Action [triggerIssue] in [Merge the new workflow into the master branch] does not match the `createIssue` action's schema
  - "store" is not allowed
- "steps[5].link" does not match any of the allowed types

github-learning-lab[bot] commented 4 years ago

:red_circle: 16 errors found in the config file.

- Action [2] in [GitHub Actions: Using GitHub Script] does not match the `createIssue` action's schema
  - "store" is not allowed
- "steps[0].link" does not match any of the allowed types
- Action [5] in [Setup a workflow file] does not match the `createReview` action's schema
  - "store" is not allowed
- "steps[1].link" does not match any of the allowed types
- Action [triggerIssue] in [Merge the new workflow into the master branch] does not match the `createIssue` action's schema
  - "store" is not allowed
- "steps[2].link" does not match any of the allowed types
- "steps[3].link" does not match any of the allowed types
- Action [5] in [Modify your workflow file] does not match the `createReview` action's schema
  - "store" is not allowed
- "steps[4].link" does not match any of the allowed types
- Action [triggerIssue] in [Merge the new workflow into the master branch] does not match the `createIssue` action's schema
  - "store" is not allowed
- "steps[5].link" does not match any of the allowed types

github-learning-lab[bot] commented 4 years ago

:red_circle: 1 errors found in the config file.

- "steps[5].link" does not match any of the allowed types

github-learning-lab[bot] commented 4 years ago

:red_circle: 1 errors found in the config file.

- "steps[5].link" does not match any of the allowed types

github-learning-lab[bot] commented 4 years ago

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!

github-learning-lab[bot] commented 4 years ago

:red_circle: There was an error parsing your config.yml file.

YAMLException: can not read an implicit mapping pair; a colon is missed at line 58, column 51:
     ... ates === true Then do this stuff
                                         ^

brianamarie commented 4 years ago

I'm going through this course for the 2nd time with an eye on the flow with the bot activating the triggers for the actions. It didn't stand out to me before, but I do think there's a chance to reduce confusion here. If I'm understanding correctly, I see the pros/cons as:

The bot opening the issue

👍One less step for the learner to complete
👍All learner actions are about writing code
👎We are assuming that the learner can differentiate between bot activity and action-triggered activity (This is a big one to me - there is a lot of mystery behind Learning Lab, and I think it's a risk to let users confuse the Learning Lab things and the Action things. We can't validate their understanding any other way.)

The Learner opening the issue

👍Learner has to mentally connect the dots that the action is triggered by them opening an issue, or commenting, or whatever was specified in the workflow

I don't see the learner opening issues as a practice in opening issues for no reason - I see it as solidifying the understanding of the workflow that we've asked them to build.

All that said, it didn't occur to me when I went through the course for the first time. Just my two cents 💰

mattdavis0351 commented 4 years ago

@brianamarie imagine a real world project. I set up the workflow for that repo, and that workflow responds to issues when they are opened by the community. Once I did that I would have to wait for people to open issues themselves, aside from the ones that I may or may not open to track things.

By having the bot open the issue, I feel as though it simulates a more accurate representation of this workflow in the wild. The bot essentially becomes a community member that has stumbled on your repo and opened an issue for whatever reason.

I worry that if the learner is the one who triggers this workflow then we lose that simulation. We could also run the risk of the learner assuming this workflow is tied to them opening issues, and not anyone in the world. That risk is small, but if I'm super new to GitHub and collaboration this is a potential misconception.

Taking the simulated aspect into account, does that change your feedback in anyway?

brianamarie commented 4 years ago

@mattdavis0351 I completely see what you mean. My reasoning is that while simulating the environment is important, it may lose value as a training exercise if it's so realistic that we sacrifice the scaffolding that creates a positive learning experience.

As a possible compromise, what if we had the user trigger the first several instances to solidify the knowledge, then show it as another collaborator later in the course?

hectorsector commented 4 years ago

@mattdavis0351 I added some validations that I think will help!

hectorsector commented 4 years ago

@mattdavis0351 based on our conversations over Slack, I'm going to merge this so I can get this course QA'd.

githubtraining / write-github-script