Scan for open tickboxes in PR

[jessevdp]

In my workflow I like to add tickboxes to PR descriptions to indicate items that need to be completed before a PR can be merged, or even reviewed. I imagine many other people have a similar workflow.

Scanning for open tickboxes would technically be possible on a pro-plan (I haven't tested this) by scanning for the litteral string - [ ] in the PR description. (You can set phrases and location right?) However it might be cool and useful to allow users to just enable this without this workaround.

Just thought I'd drop this here. 👍

[jessevdp]

Example

To do before merging 📝

• Update docs
• Etc.

[gr2m]

Hoi Jesse! I had the very same idea the other day!

Scanning for open tickboxes would technically be possible on a pro-plan (I haven't tested this) by scanning for the litteral string - [ ] in the PR description. (You can set phrases and location right?)

Yes, you can set phrases and location, but you cannot set location to look in the pull request body yet.

However it might be cool and useful to allow users to just enable this without this workaround.

I want to keep the free version intentionally simple, but happy to add "body" as a valid location value. So it would require the pro version but hey it’s just $1/month and I’ll donate all the revenue to RGSoC. Plus if you cannot pay for some reason, you can always add your account or org here: https://github.com/wip/app/blob/master/pro-plan-for-free.js

One thing that might be helpful that is documented yet is the ability to configure your WIP installation once for all repositories. Create a .github repository and in that repository, create a .github/wip.yml file.

Pull request welcome :)

[gr2m]

Hey Jesse, are you still interested in adding the support for the checkboxes?

I’m considering working on it

[jessevdp]

Hi. I looked at this one afternoon after I submitted this issue. But I couldn’t quickly make sense of where to add this. (Messing with someone elses code base always requires some time to read in to it...)

Anyway. Ive been SUPER busy with school since then. And I will be for a while longer.

[gr2m]

I can look into it myself, I was just curious if you were still interested in the feature, and if others are

[jessevdp]

I definitely am. Since GitHub implemented draft PR's which offer a lot of the same functionality, this would be a great feature to go beyond what is natively offered already. And one that I actually see the use of in my current workflow. (Basically every PR template that I create has a TODO actions section.)

While I am on the subject. I do think this bot has a few advantages (at least differences) over the draft PR feature. 1) You can re-mark a PR as a draft by adding the (WIP) annotation again. 2) Other bots actually run while the PR is WIP, allowing you to see the results at an early stage. Not sure if that is really needed for anyones workflow, but I kind of like it.)