Automated Workflows

The following workflows have been set up under

Self-assign an issue

Any contributor can self-assign an issue to themselves by commenting on an issue with the following command. The workflow will also add the Self-Assigned label to the issue.

  • //assign

(Workflow: .github/workflows/self-assign-issue.yml)

Top ↑

Add a content development checklist

The following commands create a new comment on the issue with the relevant content development checklist. A command can be added to either the issue body upon creation, or as a new comment.

  • //tutorial
  • //online-workshop
  • //lesson-plan
  • //course

Please note that checklists added with these commands can only be ticked off by people who have been added to the Learn Content Triage Group. Currently, this access is limited to Faculty Members. General contributors will be guided to copy-paste a checklist from the relevant handbook page at the end of the topic vetting process.

(Workflows: .github/workflows/comment-with-checklist.yml, .github/workflows/content-checklist-from-issue.yml, .github/workflows/content-checklist-from-comment.yml)

Top ↑

Add review instructions

Once a content is ready to be reviewed, a comment should be made on the issue listing steps for how someone can review the issue. This workflow will do just that, linking to the Guidelines for Reviewing Content handbook page and adding a review check-list that contributors can copy-paste into a new comment.

  • //review

(Workflow: .github/workflows/review-instructions.yml)

Top ↑

Close a content issue that was published

When a content has been published, the issue should be closed with the following command, rather than simply pressing Close Issue in GitHubGitHub GitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. The workflow will add a [Content] Published label to the issue, remove the [Content] Needs Co-host label should it exist on the issue, and close the issue.

  • //publish

(Workflow: .github/workflows/published-content.yml)

Top ↑

Label and triage feedback issue

The following commands are used to triage feedback issues. A command can be added to either the issue body upon creation, or as a new comment. The workflow will only trigger if the Awaiting Triage label is also present.

  • //content
  • //dev
  • //handbook

(Workflows: .github/workflows/label-feedback-from-issue.yml, .github/workflows/label-feedback-from-comment.yml)

Last updated: