decouple tbdocs commenter

[leordev]

Now we also have the tbdocs report in the GH Action summary!

https://github.com/TBD54566975/web5-js/actions/runs/7039346479?pr=323#summary-19158131202

• Decouples the docs reporter from the CI tests
• Decouples the PR comments generation from the tbdocs activity because secrets are not exposed to forked PRs
  • we could either create a server app to watch the PR and open a comment from the server (same approach taken by CodeCov reports which are passing in our PRs!)
  • or, per the github workflows security recommendations, use the workflow_run trigger to safely execute code from the main branch, access secrets and be able to create the report comment
    • Keeping your GitHub Actions and workflows secure Part 1: Preventing pwn requests
    • workflow_run usage example

PS: the tbdocs report comment in the PR will only start to show up when we merge this PR to main. Unfortunately this is the normal behavior for new workflow_run definitions.

Working evidence:

• TBDocs PR with a comment: testing error tbdocs#89 (comment)
• TBDocs Commenter workflow_run triggered action logs: https://github.com/TBD54566975/tbdocs/actions/runs/7039271133/job/19157923330#step:5:12

[codesandbox]

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders

Open Preview

[codecov]

Codecov Report

Merging #323 (b8d5c4f) into main (dce370d) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #323   +/-   ##
=======================================
  Coverage   91.77%   91.77%           
=======================================
  Files          73       73           
  Lines       15764    15764           
  Branches     1448     1448           
=======================================
  Hits        14468    14468           
  Misses       1270     1270           
  Partials       26       26           

Components	Coverage Δ
api	96.69% <ø> (ø)
common	95.00% <ø> (ø)
credentials	94.32% <ø> (ø)
crypto	100.00% <ø> (ø)
dids	88.75% <ø> (ø)
agent	88.08% <ø> (ø)
identity-agent	56.81% <ø> (ø)
proxy-agent	58.43% <ø> (ø)
user-agent	55.22% <ø> (ø)

[shamilovtim]

Should this run on push only rather than on every commit of every PR?

on:
  push:
    branches:
      - main

[frankhinek]

Caught up with @leordev about getting the next step done after this which is to publish the API docs to gh-pages. Hope to get that prioritized for next week.