Skip to content

refactor: rewrite profile readme in quarto#54

Open
kelly-sovacool wants to merge 63 commits into
mainfrom
refactor-quarto
Open

refactor: rewrite profile readme in quarto#54
kelly-sovacool wants to merge 63 commits into
mainfrom
refactor-quarto

Conversation

@kelly-sovacool
Copy link
Copy Markdown
Member

@kelly-sovacool kelly-sovacool commented Apr 6, 2026

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 with quarto 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:

quarto render profile/README.qmd -M eval:false

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

(Strikethrough any points that are not applicable.)

  • This comment contains a description of changes with justifications, with any relevant issues linked.
  • [ ] Write unit tests for any new features, bug fixes, or other code changes.
  • [ ] Update docs if there are any API changes.
  • [ ] Update CHANGELOG.md with a short description of any user-facing changes and reference the PR number. Guidelines: https://keepachangelog.com/en/1.1.0/

@kelly-sovacool kelly-sovacool requested a review from kopardev April 6, 2026 22:33
@kelly-sovacool kelly-sovacool enabled auto-merge (squash) April 7, 2026 16:48
Comment thread .github/workflows/update-org-readme.yml Outdated
@kelly-sovacool
Copy link
Copy Markdown
Member Author

@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>
Copy link
Copy Markdown

Copilot AI commented May 15, 2026

@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 ...

Implemented in a268994. I updated the README data-fetch scripts to fail fast with explicit RuntimeError messages when critical GitHub API calls fail (including auth/permission failures like expired GITHUB_TOKEN) instead of silently returning partial/empty data. This now causes Quarto rendering to fail explicitly when critical data cannot be retrieved. No UI changes were made (workflow/script-only change).

Copy link
Copy Markdown
Contributor

@kopardev kopardev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewing the workflow changes, I found one functional bug and a near-term Actions runtime risk.

Comment thread .github/workflows/update-org-readme.yml
Comment thread .github/workflows/update-org-readme.yml Outdated
Comment thread .github/workflows/update-org-readme.yml
@kelly-sovacool kelly-sovacool requested a review from kopardev May 20, 2026 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

update pipeline descriptions in profile readme for website release table is formatted incorrectly

4 participants