wyozi / contextual-qa-checklist-action Goto Github PK

Github action for filename-based QA checklists in PRs

TypeScript 100.00%

contextual-qa-checklist-action's Introduction

Github action for Contextual QA Checklists

Tests are nice, but sometimes you want an additional checklist of items to check before merging a PR (for example, grammar check for documentation changes or last-minute check of visual look). This action allows you to build filename-based checklists to remind the PR author about.

The action reads a checklist specification file (by default CHECKLIST.yml) from the repository root and submits a checklist comment to new/modified PRs based on what files were modified.

Example

Checklist specification

CHECKLIST.yml

paths:
  "README.md":
    - Did you remember to add code examples for newly added methods?
    - Did you make sure that all the example code still functions as expected?
    - Did you remember to update screenshots to match new updates?
  "src/components/**/*.js":
    - Did you check that the component visual look still matches design documents?
  "docs/**":
    - Did you run changes past the copywrite team?

Only one property, paths, is supported at the moment. It takes path specifications as key and a list of items as value.

Action

.github/workflows/checklist.yml

on: [pull_request_target]

jobs:
  checklist_job:
    runs-on: ubuntu-latest
    name: Checklist job
    steps:
      - name: Checkout
        uses: actions/checkout@v1
      - name: Checklist
        uses: wyozi/contextual-qa-checklist-action@master
        with:
          gh-token: ${{ secrets.GITHUB_TOKEN }}
          # See options documentation below

Options

`comment-header`

Overrides the default header text in the PR comment.

`comment-footer`

Overrides the default footer text in the PR comment.

`merge-comment`

Merges any new checklist items with the existing checklist comment.

`include-hidden-files`

Includes files and folders starting with . when matching. Defaults to false.

`input-file`

The path to the checklist definition file. Default to CHECKLIST.yml in the project root.

`gh-token`

The Github token for you project.

`show-paths`

Shows the matched file path in the PR comment. Defaults to true.

Result

When matching files are updated in a PR, the action will automatically post a checklist containing items under that path's key.

See #10 (comment) for an example PR checklist

contextual-qa-checklist-action's People

Contributors

Stargazers

Watchers

Forkers

markolech fuyufjh adamcrews batbattur ifixit automattic markdorison edelciomolina cryogenicbot n8n-io kierankaelin

contextual-qa-checklist-action's Issues

Error: Empty value for parameter 'pull_number': undefined

Whenever I merge pull requests into the master branch, the checklist fails for this error. It passes upon the initial push of the pull request, though. I wonder if this is related to probot/probot#1168? Would you be able to help me with this error?

Issue with regular expression in the path

In a CHECKLIST.yml, I found something strange, that looks like a regex issue.
This setting wasn't working:

paths:
  "folder1/folder2/**.py":
    - Does anything need to be updated?

Whereas the following works great for me:

paths:
  "folder1/folder2/**/*.py":
    - Does anything need to be updated?

But in your documentation you recommend something like this ("src/components/**.js":).

What is wrong with my code?

Resource not accessible by integration

Integration finished with error: Resource not accessible by integration.
I do not have access to repository where I created PR, can this be a reason?

Log with failed pipeline: https://github.com/timberio/vector/pull/2735/checks?check_run_id=738118493

New path to CHECKLIST (via input-file) not working

Setting the path to the CHECKLIST file does not work or I do not use input-file in the right way.
I'm getting this outcome:

> Run wyozi/contextual-qa-checklist-action@master
  with:
    gh-token: ***
    input-file: .github/CHECKLIST.yml
    comment-header: Great PR! Please pay attention to the following items before merging:
    comment-footer: This is an automatically generated QA checklist based on modified files
    include-hidden-files: false
    show-paths: true
Error: ENOENT: no such file or directory, open '.github/CHECKLIST.yml'

And yes, I created the file at the right place: sandbox/.github/CHECKLIST.yml (sandbox being the repo name)

Support for using OR (|) in paths

I am trying to use a regular expression to include multiple paths at the same time, hoping to apply the same Checklist. However it's not working, what I tried so far:

This is not triggering a checklist:
https://github.com/ivansabik/contextual-qa-checklist-action-regex/pull/2

Run wyozi/contextual-qa-checklist-action@master
No paths were modified that match checklist paths

Are OR expressions supported via pipe character in the regular expression?

I am getting error "Not Found"

I have tested the referenced file is accessible from action.
Here input-file: ./.github/CHECKLIST.yml is in develop branch and i have checked it is getting checked out correctly.

wyozi / contextual-qa-checklist-action Goto Github PK

contextual-qa-checklist-action's Introduction

Github action for Contextual QA Checklists

Example

Checklist specification

Action

Options

comment-header

comment-footer

merge-comment

include-hidden-files

input-file

gh-token

show-paths