nmfs-fish-tools / ghactions4r

Reusable github actions workflows for R packages
https://nmfs-fish-tools.github.io/ghactions4r/
12 stars 1 forks source link

Issue 126: deprecate style only, style description only, and document only workflows #131

Closed k-doering-NOAA closed 2 months ago

k-doering-NOAA commented 2 months ago

Addresses #126. This PR:

Users of these reusable workflows should instead use the doc-and-style-r reusable workflow, which can be set up using ghactions4r::use_style_and_document()

I think a remaining step that I should take would be to post an issue on repositories that are using this workflow, as I'm not sure the warnings are visible enough: example of a warning

@iantaylor-NOAA would you be able to review this within the next week? If not, I can see if @kellijohnson-NOAA or @Bai-Li-NOAA are available.

codecov-commenter commented 2 months ago

:warning: Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 95.47%. Comparing base (efda7e9) to head (690f245).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #131 +/- ## ========================================== + Coverage 92.62% 95.47% +2.85% ========================================== Files 3 3 Lines 217 199 -18 ========================================== - Hits 201 190 -11 + Misses 16 9 -7 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

k-doering-NOAA commented 2 months ago

@iantaylor-NOAA thanks so much for getting to this so quickly.

good point about adding a date! I'll make it December (unless @Bai-Li-NOAA is ok with removing them while I'm out, and I can let her pick the date :) )

I'm planning on just deleting the reusable workflows, which should cause the github actions to fail

I'll leave this open until I've posted on the repos that are using the workflows and the deprecation date has been added.

iantaylor-NOAA commented 2 months ago

@k-doering-NOAA, sounds good. December is fine. I just updated one of the repos by running ghactions4r::use_r_cmd_check(), ghactions4r::use_doc_and_style_r(), and deleting old files which only took about 2 minutes: https://github.com/pfmc-assessments/PEPtools/commit/10eddd1971d57c34229a88e1a4454cd89c164c57.

k-doering-NOAA commented 2 months ago

Opened PRs to replace style or document only workflows with style and document workflow on the following https://github.com/afsc-assessments/spmR, https://github.com/nmfs-fish-tools/projectstats, https://github.com/pfmc-assessments/PacFIN.Utilities, https://github.com/ss3sim/ss3sim, https://github.com/pfmc-assessments/nwfscSurvey, https://github.com/nmfs-fish-tools/r4MAS. Those were the only remaining repos using these workflows.