Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add workflow to check checklist and PR template #17

Merged
merged 2 commits into from
Sep 1, 2024

Conversation

josh-wong
Copy link
Owner

Description

This PR adds a workflow to check if items in a checklist have been checked and then leaves a comment about whether the check was a success or a failure.

Related issues and/or PRs

N/A

Changes made

  • Created a workflow file that uses an action to check if items in an opened or edited pull request have been checked.
  • Changed the Checklist heading from Markdown to HTML, and added an id value to link to that section in comments about the workflow failing.
  • Added a PR template.

Checklist

The following is a best-effort checklist. If any items in this checklist aren't applicable to this PR, add N/A after each item.

Documentation

  • I have updated the side navigation as necessary. N/A
  • I have updated the documentation to reflect the changes. N/A
  • I have documented or updated any remaining open issues linked to this PR in GitHub, Obsidian, etc. N/A

Build, deploy, and test

  • I have merged and published any dependent changes in other PRs. N/A
  • I have commented my code, particularly in hard-to-understand areas. N/A
  • I have checked that my changes look as expected on a locally built version of the docs site. N/A
  • My changes generate no new warnings.

@josh-wong josh-wong added the enhancement New feature or request label Sep 1, 2024
@josh-wong josh-wong self-assigned this Sep 1, 2024
Copy link

github-actions bot commented Sep 1, 2024

All items in the checklist have been checked🎉

@josh-wong josh-wong merged commit 1b1e4a4 into main Sep 1, 2024
1 check passed
@josh-wong josh-wong deleted the add-checklist-checking-workflow-and-pr-template branch September 1, 2024 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant