https://github.com/kasaikou/pr-checklist-action

This actions makes checklist for pull request self reviewing.
https://github.com/kasaikou/pr-checklist-action

actions github-actions pull-requests

Last synced: 7 days ago
JSON representation

This actions makes checklist for pull request self reviewing.

• Host: GitHub
• URL: https://github.com/kasaikou/pr-checklist-action
• Owner: kasaikou
• License: mit
• Created: 2024-10-18T06:29:34.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-11-05T22:55:50.000Z (2 months ago)
• Last Synced: 2024-11-05T23:31:21.752Z (2 months ago)
• Topics: actions, github-actions, pull-requests
• Language: TypeScript
• Homepage:
• Size: 3.48 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pr-checklist-action

This action makes checklist for pull request self reviewing.



  



## Usage

Save `pr-checklist.yaml` in repository root directory.

```yaml

contents:

  - name: SQL

    rules:

      - labels: [^sql$]

    checks:

      - Consider about N + 1 problem?

```

And save `.github/workflows/checklist.yml`

```yaml

on:

  pull_request:

    branches: [main]

    types: [opened, synchronize, labeled, unlabeled]

jobs:

  run:

    permissions:

      contents: read

      pull-requests: write

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v4

      - uses: kasaikou/pr-checklist-action@main

        with:

          github-token: ${{ secrets.GITHUB_TOKEN }}

          config: pr-checklist.yaml

```

## Options

| property | required (or default) | description

| :--: | :--: | :--

| github-token | required | GitHub token for read contents and making pull-request comments.

| config | (pr-checklist.yaml) | Config file path.

| message-on-empty | ( :innocent: **Check List is Empty** :innocent:) | Message displaying when there is no applicable checklist.