Skip to content

Conversation

@sbfnk
Copy link
Contributor

@sbfnk sbfnk commented Dec 4, 2025

Summary

  • Remove path filters from R-CMD-check and test-coverage workflows
  • This allows these to be required checks in branch protection
  • Previously, README-only PRs wouldn't trigger these checks, blocking merges if they were required

Summary by CodeRabbit

  • Chores
    • Updated continuous integration workflows to streamline build and testing processes, including improved automation token handling and expanded trigger coverage for quality assurance checks.

✏️ Tip: You can customize this high-level summary in your review settings.

sbfnk and others added 3 commits December 3, 2025 16:55
Update render_readme.yml to use app token so PRs created by this workflow
trigger CI checks. The default GITHUB_TOKEN doesn't trigger workflows.

Co-Authored-By: sbfnk-bot <242615673+sbfnk-bot@users.noreply.github.com>
Replace deprecated tibdex/github-app-token@v2 with the official
actions/create-github-app-token@v1 action.

Co-Authored-By: sbfnk-bot <242615673+sbfnk-bot@users.noreply.github.com>
Run these workflows on all PRs so they can be required checks in branch protection.

Co-Authored-By: sbfnk-bot <242615673+sbfnk-bot@users.noreply.github.com>
@coderabbitai
Copy link

coderabbitai bot commented Dec 4, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Modified three GitHub Actions workflows: removed path-based trigger filters from R-CMD-check.yaml and test-coverage.yaml workflows so they execute on all changes; added GitHub App token generation to render_readme.yml and replaced static GitHub token authentication with the dynamically generated token.

Changes

Cohort / File(s) Summary
Workflow trigger filters removed
.github/workflows/R-CMD-check.yaml, .github/workflows/test-coverage.yaml
Removed path filtering from push and pull_request event triggers, causing workflows to execute for all changes instead of only specified file paths
Token authentication update
.github/workflows/render_readme.yml
Added "Generate token" step using actions/create-github-app-token@v1 with secrets-based credentials; updated "Checkout repos" and "Create Pull Request" steps to use the generated token instead of static GITHUB_TOKEN

Possibly related PRs

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main changes in the pull request: removal of path filters from two GitHub Actions workflows (R-CMD-check and test-coverage).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
.github/workflows/render_readme.yml (1)

42-42: Consider removing unused GITHUB_PAT environment variable.

Line 42 sets GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}, but this environment variable does not appear to be used directly in the visible workflow steps. If it was relied upon by dependencies (e.g., R packages), verify it is still needed after switching to the GitHub App token. If unused, consider removing it to reduce confusion.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8e77a59 and 8baa832.

📒 Files selected for processing (3)
  • .github/workflows/R-CMD-check.yaml (0 hunks)
  • .github/workflows/render_readme.yml (2 hunks)
  • .github/workflows/test-coverage.yaml (0 hunks)
💤 Files with no reviewable changes (2)
  • .github/workflows/R-CMD-check.yaml
  • .github/workflows/test-coverage.yaml
🧰 Additional context used
🪛 actionlint (1.7.9)
.github/workflows/render_readme.yml

48-48: avoid using deprecated input "app_id" in action "actions/create-github-app-token@v1": 'app_id' is deprecated and will be removed in a future version. Use 'app-id' instead

(action)


49-49: avoid using deprecated input "private_key" in action "actions/create-github-app-token@v1": 'private_key' is deprecated and will be removed in a future version. Use 'private-key' instead

(action)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (7)
  • GitHub Check: ubuntu-latest (devel)
  • GitHub Check: ubuntu-latest (release)
  • GitHub Check: ubuntu-latest (4.4)
  • GitHub Check: macOS-latest (release)
  • GitHub Check: ubuntu-latest (oldrel-1)
  • GitHub Check: windows-latest (release)
  • GitHub Check: pkgdown
🔇 Additional comments (1)
.github/workflows/render_readme.yml (1)

44-109: Ensure GitHub App secrets and permissions are properly configured before merging.

The workflow uses a GitHub App token (APP_ID and APP_PRIVATE_KEY secrets) for checkout and pull request creation. Before this workflow can function:

  1. Create a GitHub App with the contents: write and pull-requests: write permissions
  2. Store the App ID in the APP_ID repository secret
  3. Store the private key in the APP_PRIVATE_KEY repository secret
  4. Install the GitHub App on this repository

Verify these are configured in repository settings; the workflow will fail at runtime if the secrets are missing or the app permissions are insufficient.

@joshwlambert
Copy link
Collaborator

What does the GitHub App token add if the CI workflow triggers are removed?

@sbfnk
Copy link
Contributor Author

sbfnk commented Dec 4, 2025

What does the GitHub App token add if the CI workflow triggers are removed?

It's the filters that are removed - in #185 R-CMD-check and test-coverage aren't triggered because of the filters.

sbfnk and others added 2 commits December 4, 2025 10:24
- Use app-id/private-key instead of deprecated app_id/private_key
- Remove unused GITHUB_PAT env var (token is passed directly where needed)

Co-Authored-By: sbfnk-bot <242615673+sbfnk-bot@users.noreply.github.com>
@sbfnk sbfnk merged commit 5dde70d into main Dec 4, 2025
10 checks passed
@sbfnk sbfnk deleted the use-epiforecast-workflow branch December 4, 2025 10:26
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.

3 participants