Question about add checklist

[lwasser]

This responder seems to provide a way for us to add checklists.

i have currently set this up so that there are two commands associated with creating checklists

however neither of these appear to work / appear in pyosbot help commands.

yaml looks like this now:

    add_remove_checklist:
      - editor_response:
          only: editors
          command: editor response
          template_file: editor_response.md
          data_from_issue:
            - reviewers-list
            - author-handle
      - package_accepted:
          only: editors
          command: package accepted
          template_file: package_accepted_template.md
          data_from_issue:
            - package-name

i'm curious what i'm doing wrong with setting these up.

this issue is where i'm testing things

[lwasser]

this is still an issue @xuanxu i see the commands for add checklist and there are several of them

i think by default the add checklist command adds the cnecklist to the review header. We have however a few different checklists.

1. a check list for reviewers. we normally embed that within the issue rather than adding to the header
2. A check list for kicking off the review where the duedate is included in the template .
3. a final approve check list with things to do to wrap up the review (similar to what ros has).

Can check list be used to just add a new checklist to the issue or will it always embed the review at the top of the issue?

i looked at ros and it doesn't seem like they are embedding reviews at the top of the issue. we might need a generic add checklist element that adds a message to the issue for a specific step. but first i just want to understand if the existing responder can be customized and reused several times to post different checklists to the review.

add_remove_checklist:
      - editor_response:
          only: editors
          command: editor response
          template_file: editor_response.md
          data_from_issue:
            - reviewers-list
            - author-handle
      - package_accepted:
          only: editors
          command: package accepted
          template_file: package_accepted_template.md
          data_from_issue:
            - package-name

[xuanxu]

The "add/remove checklist" responder is meant to add a checklist in the body of the issue.

If you just want to create a comment with a checklist that can be done with a regular "basic command" responder where the template is a checklist, this comment will be created by the bot, so only people in the organization will have permission to edit it (check items). So it's ok for editors & EiCs checklists.

There is another responder (reviewer_checklist_comment) that will edit the comment of the user to add a checklist, so the user can update it. It was created to have the reviewers checklist editable by the reviewer so now there's no need to invite them to the joss organization before hand.