refactor: rewrite profile readme in quarto#54
Conversation
for more information, see https://pre-commit.ci
9e505f5 to
7327e73
Compare
for more information, see https://pre-commit.ci
|
@copilot When the omnitoken expires, the quarto is still rendered and the workflow completes successfully, but data is missing because insufficient permissions were provided for the github api due to the expired token. See this recent commit for an example of this problem: 9494464. Fix the code so that an explicit error is thrown if critical data cannot be retrieved such as due to an expired token. |
Agent-Logs-Url: https://github.com/CCBR/.github/sessions/51fd52e3-029d-4ac0-b8be-ce42d27a73d8 Co-authored-by: kelly-sovacool <17768269+kelly-sovacool@users.noreply.github.com>
Implemented in a268994. I updated the README data-fetch scripts to fail fast with explicit |
for more information, see https://pre-commit.ci
kopardev
left a comment
There was a problem hiding this comment.
Reviewing the workflow changes, I found one functional bug and a near-term Actions runtime risk.
Changes
Re-write the make_readme action and scripts as a quarto document for a simplified design. Removes a lot of boilerplate code and makes the readme easier to understand. Instead of calling
make_readme.sh, the readme is now updated withquarto render profile/README.qmd. The content in the rendered file (profile/README.md) is nearly identical to the original, with the only differences being line wrapping.Importantly, the workflow now fails when data cannot be retrieved from the GitHub API. This ensures the workflow doesn't fail silently when tokens expire or have insufficient permissions.
You can test how the README file is rendered without running the Python code chunks with:
AI Use: I used Copilot in VS Code to assist in this refactor, plus Copilot via the GitHub web interface for refinement.
Issues
fixes #45
resolves #67
PR Checklist
(
Strikethroughany points that are not applicable.)[ ] Write unit tests for any new features, bug fixes, or other code changes.[ ] Update docs if there are any API changes.[ ] UpdateCHANGELOG.mdwith a short description of any user-facing changes and reference the PR number. Guidelines: https://keepachangelog.com/en/1.1.0/