Description

The framework coverage difference commenter currently posts a new comment after new commits. When there are a lot of these comments on a PR, it can be hard to find comments from reviewers. This PR changes the workflow so that it updates one comment box instead of creating multiple comments.

Note: this code is based on the QHelp preview comment workflow which updates one comment box. The first commit 9263cfd is based on this code in qhelp-pr-preview.yml. The second commit 6e29b70 is based on this code in post-pr-comment.yml.

This PR also fixes a bug ee4a9c3 that was causing a 'list index out of range' error in the pre-existing get_previous_run_id function. f"branch='{pr_branch}'" resulted in incorrect branch names such as 'branch='"'"'test-commenting'"'"'' due to apparent escaping of the single quotes, and the subprocess_check_output call always returned an empty list as a result since the branch name was incorrect. Changing this code to f"branch={pr_branch}" seems to resolve the issue.

Testing

I've tested these changes on https://github.com/dsp-testing/codeql-framework-coverage-pr-commenter/pull/27 (let me know if you don't have access to this PR).

• The first commit removes a MaD model, so the workflow posts an initial comment (workflow run).
• The second commit removes another MaD model, so the workflow updates the existing comment (workflow run).
• The third commit tests the bug fix in the get_previous_run_id function. It does not change any MaD models, so the diff is the same as the prior run, and the comment is not updated (workflow run).