mnot / ietf-comments Goto Github PK

View Code? Open in Web Editor NEW

4.0 4.0 4.0 154.05 MB

Automating IETF comment handling

License: BSD 2-Clause "Simplified" License

Makefile 5.32% Python 94.68%

github ietf markdown python

ietf-comments's People

Contributors

Stargazers

Watchers

Forkers

rgwilton larseggert ljaidi inggrid061190

ietf-comments's Issues

colorama dependency?

I had to install colorama manually (pip install) to make ietf-comments work.

Loop reviewer into issues

It'd be nice if a reviewer could indicate their GitHub @ so that they can be cc:ed on issues created for them.

Creating a response to the review

It might be interesting to create an e-mail (or even send it?) containing the review appropriately quoted, with responses along the lines of "this issue was created at https://github.com/owner/repo/issues/nnn".

Please document permissions required

Specifically, I used the tool for a repo that I do not own.

I had to use a "personal access token (classic)", with "repo" permissions.

And I could NOT use the --auto-label flag.

Extract resolutions from GH issues for reply e-mails

Right now, the workflow for these tools is:

Receive comments
Run tool to create issues
Work towards issue resolution
Copy resolutions by hand into response e-mail to reviewer

It seems like (4) could be automated.

The first thing that'd be necessary is the ability to recreate the text of the comment. That could be extracted from the issues themselves (although we'd need to be careful to do it accurately -- e.g., cc adds text).

Then, we'd need to have some reliable way to flagging the resolution text in the issue to put in the response. That could be some keyword in the issue comment, or it could be e.g., a reaction.

Restart recommendations are inaccurate, resulting in duplicate issues

The error message on hitting a rate limit helpfully provides a suggestion of restarting while skipping the first few issues. Unfortunately, the count provided there is inaccurate, resulting in duplicate issues being created. Suggested resolutions:

Provide accurate results
(even better) Check for exact duplicate issues before posting an issue
(even better) Provide an option to have the tool automatically retry after the lockout

For example, in the below case, You can see that issues 765-778 are duplicates of 782-795. Oddly the lists diverge after that.

% ietf-comments review.md -g mlswg/mls-protocol -a
Document: draft-ietf-mls-protocol
Revision: 15
CC: @paulwouters
* Created issue 762 in mlswg/mls-protocol: Interaction of MLS and application
* Created issue 763 in mlswg/mls-protocol: Security against malicious members?
* Created issue 764 in mlswg/mls-protocol: Should B receive its own Commit back?
* Created issue 765 in mlswg/mls-protocol: Section 6.3 use of "member"
* Created issue 766 in mlswg/mls-protocol: ENUMs limited to 1 octet?
* Created issue 767 in mlswg/mls-protocol: Epoch rollover?
* Created issue 768 in mlswg/mls-protocol: Padding with zeros
* Created issue 769 in mlswg/mls-protocol: XOR guard
* Created issue 770 in mlswg/mls-protocol: KDF.Nh
* Created issue 771 in mlswg/mls-protocol: Time is not on our side?
* Created issue 772 in mlswg/mls-protocol: lifetime field
* Created issue 773 in mlswg/mls-protocol: Section 8.4
* Created issue 774 in mlswg/mls-protocol: Section 13/14 Race conditions ?
* Created issue 775 in mlswg/mls-protocol: Section 15.1
* Created issue 776 in mlswg/mls-protocol: NOOPs ?
* Created issue 777 in mlswg/mls-protocol: Section 17
* Created issue 778 in mlswg/mls-protocol: Section 17.6
* Created issue 779 in mlswg/mls-protocol: memberlist unavailble before joining
* Created issue 780 in mlswg/mls-protocol: Prospective member or member ?
* Created issue 781 in mlswg/mls-protocol: "server" is ambiguous here
Github Issue Creation Error: You have exceeded a secondary rate limit and have been temporarily blocked from content creation. Please retry your request again later. - restart with --start=4
% ietf-comments review.md -g mlswg/mls-protocol -a --start=4
Document: draft-ietf-mls-protocol
Revision: 15
CC: @paulwouters
* Created issue 782 in mlswg/mls-protocol: Section 6.3 use of "member"
* Created issue 783 in mlswg/mls-protocol: ENUMs limited to 1 octet?
* Created issue 784 in mlswg/mls-protocol: Epoch rollover?
* Created issue 785 in mlswg/mls-protocol: Padding with zeros
* Created issue 786 in mlswg/mls-protocol: XOR guard
* Created issue 787 in mlswg/mls-protocol: KDF.Nh
* Created issue 788 in mlswg/mls-protocol: Time is not on our side?
* Created issue 789 in mlswg/mls-protocol: lifetime field
* Created issue 790 in mlswg/mls-protocol: Section 8.4
* Created issue 791 in mlswg/mls-protocol: Section 13/14 Race conditions ?
* Created issue 792 in mlswg/mls-protocol: Section 15.1
* Created issue 793 in mlswg/mls-protocol: NOOPs ?
* Created issue 794 in mlswg/mls-protocol: Section 17
* Created issue 795 in mlswg/mls-protocol: Section 17.6
* Created issue 796 in mlswg/mls-protocol: Can?
* Created issue 797 in mlswg/mls-protocol: May implement correctly :-)
* Created issue 798 in mlswg/mls-protocol: 7 or 8 members
* Created issue 799 in mlswg/mls-protocol: Setion 8.7 MAY
* Created issue 800 in mlswg/mls-protocol: Section 9.5 MLS Exporter
* Created issue 801 in mlswg/mls-protocol: Section 10.1 encryption size
Github Issue Creation Error: You have exceeded a secondary rate limit and have been temporarily blocked from content creation. Please retry your request again later. - restart with --start=10

Lars' Mega-Issue

With the review files I linked to larseggert/ietf-reviewtool#10 (comment), I get the following error when trying to validate them:

Traceback (most recent call last):
  File "/usr/local/bin/ietf-comments", line 71, in <module>
    comments = parse_comments(comment_file, cli)
  File "/usr/local/lib/python3.9/site-packages/ietf_comments/parser.py", line 160, in parse_comments
    renderer.render(doc)
  File "/usr/local/lib/python3.9/site-packages/commonmark/render/renderer.py", line 19, in render
    getattr(self, type_)(event['node'], event['entering'])
  File "/usr/local/lib/python3.9/site-packages/ietf_comments/parser.py", line 35, in heading
    getattr(self, f"handle_h{node.level}")(content)
AttributeError: 'CommentRenderer' object has no attribute 'handle_h4'

The headline of the ietf-comments tool @ https://pypi.org/project/ietf-comments/ lists the install as "pip install ietf-comments" ... which failed. Can the headline be changed to "pip3 install ietf-comments".
Even after the install (which didn't have any errors as far as I can see), I can't just run ietf-comments since it isn't on my path (even though python3 is). Perhaps some further install/setup is required? This is on ubuntu.

invalid repo name prints "Error: Not Found"

e.g.

rfced-comments -g quicwg/base-draft 9204
Error: Not Found

(I missed the trailing 's').

It would help if the message could reflect that the repo was not found

ietf-comments fails to generate issues on github

dooku-[lwork/rats/architecture](2.6.6) mcr 5869 %ietf-comments -g ietf-rats-wg/architecture 197.txt
Warning: Unrecognised h2 section comment:.
Warning: Unrecognised h2 section notes.
Document: draft-ietf-rats-architecture
Revision: 21
CC: @larseggert
Github Issue Creation Error: Not Found - restart with --start=1
[1]    246718 exit 1     ietf-comments -g ietf-rats-wg/architecture 197.txt

where 197.txt comes from
https://mailarchive.ietf.org/arch/msg/rats/pLZ4oeYgStKiygg_KA5NMJN6HQg/