Repository navigation
[codex] Install whouses action - #92
Merged
Merged
Conversation
Version bump check ✅
Checked 1 group(s) against |
gvegayon
marked this pull request as ready for review
October 12, 2026 07:37
Copilot stopped reviewing on behalf of
gvegayon due to an error
October 12, 2026 07:37
There was a problem hiding this comment.
Note
Copilot was unable to run its full agentic suite in this review.
Copilot review overview
2 open findings
What changed in this PR
Adds “Used by” reporting to the project by configuring whouses and surfacing it via README badges.
Changes:
- Add a “Used by” shields.io badge to both
README.qmdand the renderedREADME.md. - Introduce
.whouses.ymlconfiguration for discovery sources and DOIs. - Add a scheduled GitHub Actions workflow to generate/update
whousesdata on a dedicated branch.
| File | Description |
|---|---|
| README.qmd | Adds a “Used by” badge pointing at generated whouses outputs. |
| README.md | Updates the rendered README to include the same badge. |
| .whouses.yml | Defines whouses project metadata, DOIs, and discovery sources. |
| .github/workflows/whouses.yml | Automates periodic generation of whouses outputs and publishes to whouses branch. |
🧠 Review effort: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+18
to
+22
| - uses: actions/checkout@v4 | ||
| - uses: gvegayon/whouses@v0 | ||
| with: | ||
| data-branch: whouses | ||
| search-token: ${{ secrets.WHOUSES_SEARCH_PAT }} |
|
|
||
|
|
||
| [](https://github.com/USCCANA/netdiffuseR/actions/workflows/r.yml) | ||
| [](https://github.com/USCCANA/netdiffuseR/blob/whouses/REPORT.md) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
netdiffuseR currently has no automated way to discover downstream use across package registries, GitHub code, and the research literature. As a result, maintainers and users cannot see consolidated usage evidence or a repository badge reflecting those findings.
This change installs the
gvegayon/whouses@v0GitHub Action. It runs every Monday and can also be started manually, with write permissions needed to maintain its data and review pull requests. Results are stored on the dedicatedwhousesbranch so generated data does not enter the package source onmaster.The package configuration selects the R profile, identifies
USCCANA/netdiffuseR, searches GitHub, ecosystems, OpenAlex, and Europe PMC, and supplies the package and software-paper DOIs for citation matching. The README badge readsbadge.jsonfrom thewhousesbranch and links to its generated report. The same badge is included inREADME.qmdso regeneratingREADME.mdpreserves it.Validation
.whouses.ymland.github/workflows/whouses.ymlsuccessfully with Ruby's YAML parser.git diff --checkwith no whitespace errors.After merge, the workflow should be dispatched once to create and populate the
whousesbranch. The optionalWHOUSES_SEARCH_PATrepository secret can improve GitHub code-search coverage.