`cml send-comment --update`: Raises 'commit_id has been locked' error

When calling cml send-comment --update from a python script using subprocess.run, the following error is being raised:

"HttpError: Validation Failed: {\"resource\":\"CommitComment\",\"code\":\"custom\",\"field\":\"commit_id\",\"message\":\"commit_id has been locked\"}
    at /usr/lib/node_modules/@dvcorg/cml/node_modules/@octokit/request/dist-node/index.js:86:21
    at processTicksAndRejections (node:internal/process/task_queues:96:5)
    at async Job.doExecute (/usr/lib/node_modules/@dvcorg/cml/node_modules/bottleneck/light.js:405:18)","status":422}

Without --update, the error is not being raised.

Code:

import subprocess

for i in range(3):
    with open("report.md", "w") as f:
        f.write(f"## {i}")
    
    subprocess.run(
        ["cml", "send-comment", "--update", "report.md"],
        check=True
    )

Example failure: https://github.com/iterative/test-cml-send-comment-pr/runs/5036525998?check_suite_focus=true#step:4:7

[0x2b3bfa0]

https://github.community/t/comment-api-does-not-describe-commit-id-has-been-locked/159853/2

Try using a personal access token instead of GITHUB_TOKEN

[daavoo]

Try using a personal access token instead of GITHUB_TOKEN

For the record, adding a PAT token with repo & workflow permissions has solved the issue.

However, it feels a little cumbersome to do this “only” to enable --update, while “no-update” works with the default token