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

👷 Added PR checklist workflow #824

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
11 changes: 11 additions & 0 deletions .github/workflows/pr-checklist.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Require PR Checklist

on:
pull_request:
types: [opened, edited, reopened, synchronize, ready_for_review]

jobs:
pr-checklist:
runs-on: ubuntu-latest
steps:
- uses: it-at-m/lhm_actions/action-templates/actions/action-pr-checklist@14080db5171a3b2a879ea09e18ea5a276fbfb189 # v1.0.1
11 changes: 11 additions & 0 deletions docs/develop.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,17 @@ This is enabled by default when using the templates. To learn more about the Dep

The allowed licenses can be viewed [here](https://opensource.muenchen.de/licenses.html#integration-in-in-house-developments).

### Require PR checklist

The templates provide a workflow for validating checklist status in a PR description. To merge a PR, all checklist items must be ticked off by the PR creator.

The templates by default ship with a [PR template](./organize.html#pull-request-template), which makes use of a checklist.

::: info Information
If some of the PR checklist items are not relevant for your PR, you should adjust the checklist inside the PR description to the specific PR changes.
If you want to disable the feature completely, you need to remove the file `.github/workflows/pr-checklist.yml`.
:::

### GitHub Rulesets

It is recommended to review the rulesets for pushing and merging in the GitHub repository. Depending on the project's branching strategy, some branches should be protected to prevent force pushes and merging without approval.
Expand Down
2 changes: 2 additions & 0 deletions docs/organize.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ This ensures a uniform review process, simplifies organization, and allows maint

Please check the official [GitHub documentation](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository) for further information.

In combination with [Require PR checklist](./develop.html#require-pr-checklist) the templates can enforce a careful examination of each PR checklist item.

::: info Information
Note that not all checkpoint items might be relevant for your project, so you have to adjust the template to your own needs.
:::
Expand Down
Loading