PR for #140 Automating PR reviews using GitHub Actions

[zhizhongpu]

No description provided.

[zhizhongpu]

List of documentation edits:

We should

• flag that some tests under .github/ are GitHub Actions that ensure the repo's integrity, while others are there to automate the PR review process. Therefore, a user might want to delete the former set of Actions but not the latter when initializing a new repo.
• say something about how to trigger GitHub Actions checks that we're adding via using e.g. a commit or a comment
  • Checks are together triggered by a commit if the commit's message contains [run-actions-all]
  • A check is triggered by a comment (/run-actions-all to run all, /run-actions-dag, /run-actions-newlines, /run-actions-eps, /run-actions-log to run individual tests).
    • adding parameter --post (e.g., commenting /run-actions-all --post) generates a new post with check results
• say that GitHub Action checks have a default timeout of 60 seconds. To adjust this time, edit timeout-minutes in .github/workflows/checks.yml
• modify workflow.md
  • to specify when during the PR review the GitHub Actions checks should be run using what triggers and by whom
  • consider the relationship between the sub-bullets under Assignees close the pull. vs the content of the posts (on the issue thread and the PR thread) posted by GitHub Actions upon PR closure. For example, the assignee should follow the checklist and check an item once and only once it's completed.
• ?say something about the billing implications of using GitHub Actions if using the Template in a private repo

[zhizhongpu]

@liaochris feel free to edit #141 (comment) if there's anything else to add. Otherwise please tag JMS and say it's ready to be reviewed / acted on.

[liaochris]

@zhizhongpu @jmshapir

In 46e8320 I improved the procedure and documentation for adding new checks so that

a) the procedure is more automated
b) the documentation is both more concise and provides a clear example

[jmshapir]

All my threads are resolved.

I left #141 (comment) open pending resolution and #141 (comment) open for visibility.

[zhizhongpu]

I'm now taking a pass at the code @liaochris

[zhizhongpu]

I'm now taking a pass at the code @liaochris

@liaochris approving!

Excited to test it in a real project.

[liaochris]

summary comment

[github-actions]

@zhizhongpu Issue summary

Thanks for closing this pull.

Before leaving the pull, please be sure you have completed all the required steps in the workflow.

This includes filling in the issue summary linked at the top of this comment.