Skip to content

Readme and auto table update workflow - #104

Merged
kellijohnson-NOAA merged 2 commits into
mainfrom
readme-and-auto-table-update-workflow
Jul 10, 2026
Merged

Readme and auto table update workflow#104
kellijohnson-NOAA merged 2 commits into
mainfrom
readme-and-auto-table-update-workflow

Conversation

@e-perl-NOAA

@e-perl-NOAA e-perl-NOAA commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

What is the feature?

  • Update the Readme with better info about the repo and added a workflow to auto update the table

How have you implemented the solution?

  • The workflow uses info in the yml of each qmd (except like the template and a few others) to fill in some of the table and then runs each qmd separately, and creates a badge if it passes or fails, pushes only the successfully rendered files to the github.io site IF it is a push or a merged pr on main, creates a PR with the updated readme file badges

Disclaimer: I doubt this PR is ready yet, I just wanted to go ahead and make it so the work being done here is more visible

@e-perl-NOAA e-perl-NOAA added the github_actions Pull requests that update GitHub Actions code label Jun 25, 2026
Comment thread .github/workflows/case-study-check.yml Outdated
Comment thread .github/workflows/case-study-check.yml Outdated
@e-perl-NOAA

Copy link
Copy Markdown
Contributor Author

@kellijohnson-NOAA, I made some more changes. This should be able to replace the current render-and-publish.yml which I have deleted in this PR as well. What I hate about github actions is that, I'm always like ... well ... you can't see it here but I tested it and it worked then, let's 🫰and 🙏🏻 that it still works when it gets merged in to main 😬😆

@iantaylor-NOAA

Copy link
Copy Markdown
Contributor

@e-perl-NOAA and @kellijohnson-NOAA, I just looked through this PR and I like it.

Having a clear message when one of the case studies breaks will be really helpful. There will be a bit of additional work when adding or modifying an existing case study, but that shouldn't be too hard to deal with and the patterns for all the others should make it clear what to add and change.

I'm not great with .yml, but I ran the R script within the workflow locally. I had to remove the "🧪🛏️" which caused an incomplete reading of the README file, but after that it was successfully updated by the script.

@iantaylor-NOAA

Copy link
Copy Markdown
Contributor

A trivial suggestion I forgot to make earlier.
I would replace the use of sprintf() with glue::glue() (copilot has done that for me several times when I've asked), which I think improves readability of the code.

Comment thread content/AFSC-GOA-pollock.qmd
Comment thread README.md

@kellijohnson-NOAA kellijohnson-NOAA left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Just a few suggestions but feel free to merge this in whenever you are ready.

Updated the README to include a new goal section and revised case studies table with additional details. Improved clarity in instructions for adding case studies and using codespaces.
update github action to push updated qmd files, not the whole website
Remove case-study-template

Co-authored-by: Kelli Johnson <kelli.johnson@noaa.gov>
@kellijohnson-NOAA
kellijohnson-NOAA force-pushed the readme-and-auto-table-update-workflow branch from 110fb20 to fde6c60 Compare July 10, 2026 14:34
@kellijohnson-NOAA
kellijohnson-NOAA merged commit 186709d into main Jul 10, 2026
1 check passed
@kellijohnson-NOAA
kellijohnson-NOAA deleted the readme-and-auto-table-update-workflow branch July 10, 2026 17:10
@kellijohnson-NOAA kellijohnson-NOAA linked an issue Jul 10, 2026 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

github_actions Pull requests that update GitHub Actions code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[feature:] Automatically render table on README

3 participants