Create R-CMD-check-CRAN-incoming.yaml #365

cjyetman · 2024-12-16T20:10:06Z

Adds a new R-CMD-check-CRAN-incoming.yaml GH Action

The Action attempts to run R CMD check in the same way that Win Builder does, enabling one to get early notification of problems that will ultimately need to be addressed before a CRAN submission. The goal is to replicate the process used on CRAN/Win Builder (which is probably not entirely possible) and make appropriate notifications when something of interest happens.

To that end, it...

runs R CMD check with arguments, environment variables, etc. as close as possible to those run on CRAN and Win Builder
parses the results for the notes directly following * checking CRAN incoming feasibility ... [12s] NOTE
parses those notes to remove notes that will always be there and/or do not suggest a needed action, e.g. Maintainer: 'CJ Yetman <cj@cjyetman.com>' and New submission
if there are notes left after the parsing
- throws an error on the GH Action
- prints the notes causing the error in the GH Action log
- prints the entire 00check.log as a Job Summary
- uploads the 00check.log as an Artifact
- adds a comment (or updates the previous comment) in the PR thread showing the CRAN incoming feasibility notes that were discovered

I'm still questioning whether it should also parse out the Version contains large components (0.0.0.9000) note. That would effectively show up on every PR unless the version number was a proper release version number, but when a release is being made it would be a good nudge that the version number needs to be changed. Thoughts on that?

It could alternatively only be run manually through workflow_dispatch and/or it could ignore the Version contains large components (0.0.0.9000) note.

github-actions · 2024-12-16T20:12:04Z

R CMD check CRAN incoming feasibility check notes found:

Found the following (possibly) invalid URLs:
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/
    From: DESCRIPTION
          README.md
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook//articles/cookbook_overview.html
    From: README.md
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/company_alignment_metric.html
    From: inst/doc/cookbook_interpretation.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/config_yml.html#by_group
    From: inst/doc/cookbook_running_the_analysis.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/config_yml.html#dir_matched_loanbooks
    From: inst/doc/cookbook_running_the_analysis.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/config_yml.html#directories
    From: inst/doc/cookbook_running_the_analysis.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/config_yml.html#manual_sector_classification
    From: inst/doc/cookbook_preparatory_steps.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/config_yml.html#match_prioritize
    From: inst/doc/cookbook_running_the_analysis.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/config_yml.html#matching
    From: inst/doc/cookbook_running_the_analysis.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/config_yml.html#prepare_abcd
    From: inst/doc/cookbook_running_the_analysis.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/config_yml.html#project_parameters
    From: inst/doc/cookbook_running_the_analysis.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/config_yml.html#sector_split
    From: inst/doc/cookbook_running_the_analysis.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/cookbook_advanced_use_cases.html
    From: inst/doc/cookbook_running_the_analysis.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/cookbook_interpretation.html#coverage-diagnostics
    From: inst/doc/cookbook_running_the_analysis.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/cookbook_preparatory_steps.html#raw-loan-books
    From: inst/doc/cookbook_running_the_analysis.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/cookbook_running_the_analysis.html#matching-process
    From: inst/doc/cookbook_interpretation.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/data_dictionary.html#company-net-aggregate-alignment-metric-with-financial-exposures
    From: inst/doc/cookbook_interpretation.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/data_dictionary.html#data-emission-intensity
    From: inst/doc/cookbook_interpretation.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/data_dictionary.html#data-tech-mix
    From: inst/doc/cookbook_interpretation.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/data_dictionary.html#data-trajectory
    From: inst/doc/cookbook_interpretation.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/data_dictionary.html#input-data-for-alignment-by-exposure-scatter-plot
    From: inst/doc/cookbook_interpretation.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/data_dictionary.html#input-data-for-buildoutphaseout-scatter-plot
    From: inst/doc/cookbook_interpretation.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/data_dictionary.html#input-data-for-sankey-plot
    From: inst/doc/cookbook_interpretation.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/data_dictionary.html#loan-book-coverage
    From: inst/doc/cookbook_interpretation.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/data_dictionary.html#match-success-rate
    From: inst/doc/cookbook_interpretation.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/data_dictionary.html#sectoral-decarbonization-approach-results-all-groups
    From: inst/doc/cookbook_interpretation.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/data_dictionary.html#target-market-share-results-all-groups
    From: inst/doc/cookbook_interpretation.html
    Status: 404
    Message: Not Found
  URL: https://rmi-pacta.github.io/pacta.multi.loanbook/articles/loanbook_aggregated_alignment_metric.html
    From: inst/doc/cookbook_interpretation.html
    Status: 404
    Message: Not Found

codecov · 2024-12-16T20:12:54Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.05%. Comparing base (42c9876) to head (b092f5b).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #365   +/-   ##
=======================================
  Coverage   80.05%   80.05%           
=======================================
  Files          29       29           
  Lines        3269     3269           
=======================================
  Hits         2617     2617           
  Misses        652      652

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

github-actions · 2024-12-16T20:19:46Z

PR Preview Action v1.4.8
Preview removed because the pull request was closed.
2024-12-19 15:35 UTC

jacobvjk · 2024-12-18T13:34:05Z

I tend to think that large components in the version number should not throw an error here, because that will be the standard situation during most of the development phase. Since bumping the version number is part of the CRAN release checklist, I believe we will not miss that when submitting to CRAN in all likelihood

Create R-CMD-check-CRAN-incoming.yaml

8716f2c

cjyetman requested a review from jacobvjk as a code owner December 16, 2024 20:10

cjyetman requested a review from jdhoffa December 16, 2024 20:10

Update R-CMD-check-CRAN-incoming.yaml

c2ebf10

cjyetman mentioned this pull request Dec 17, 2024

set _R_CHECK_CRAN_INCOMING_ to TRUE in CI for more robust testing #355

Closed

cjyetman added 2 commits December 18, 2024 08:40

add xml2 for URL checking in HTML files

2b00e09

also parse out Version contains large components note

2687f1d

cjyetman requested review from jdhoffa and removed request for jdhoffa December 18, 2024 13:42

fix regex

f86e409

jacobvjk mentioned this pull request Dec 18, 2024

Incoming check 0.1.0 #361

Closed

cjyetman added 4 commits December 18, 2024 09:32

fix syntax

7081c49

Merge branch 'main' into R-CMD-check-CRAN-incoming

2c767a5

Merge branch 'main' into R-CMD-check-CRAN-incoming

d942cb6

Merge branch 'main' into R-CMD-check-CRAN-incoming

b092f5b

jacobvjk approved these changes Dec 19, 2024

View reviewed changes

cjyetman merged commit d1991e9 into main Dec 19, 2024
12 checks passed

cjyetman deleted the R-CMD-check-CRAN-incoming branch December 19, 2024 15:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create R-CMD-check-CRAN-incoming.yaml #365

Create R-CMD-check-CRAN-incoming.yaml #365

cjyetman commented Dec 16, 2024 •

edited

Loading

github-actions bot commented Dec 16, 2024 •

edited

Loading

codecov bot commented Dec 16, 2024 •

edited

Loading

github-actions bot commented Dec 16, 2024 •

edited

Loading

jacobvjk commented Dec 18, 2024

Create R-CMD-check-CRAN-incoming.yaml #365

Create R-CMD-check-CRAN-incoming.yaml #365

Conversation

cjyetman commented Dec 16, 2024 • edited Loading

github-actions bot commented Dec 16, 2024 • edited Loading

codecov bot commented Dec 16, 2024 • edited Loading

Codecov Report

github-actions bot commented Dec 16, 2024 • edited Loading

jacobvjk commented Dec 18, 2024

cjyetman commented Dec 16, 2024 •

edited

Loading

github-actions bot commented Dec 16, 2024 •

edited

Loading

codecov bot commented Dec 16, 2024 •

edited

Loading

github-actions bot commented Dec 16, 2024 •

edited

Loading