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

[k-doering-NOAA]

Addresses #126. This PR:

• Removes the use_* functions for style only, style description only, and document only workflows
• Adds a warning to the reusable workflows that they will soon be defunct (removed).

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:

@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]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files

@@            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     

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

[iantaylor-NOAA]

Looks good to me. Thanks for working on this @k-doering-NOAA.

I agree with the idea of posting issues on the repos that use those packages (shouldn't take long with boilerplate language).

The only question I have is whether it would be better to replace "will soon be deprecated" with something like "will be deprecated on 1 Oct 2024" (or whatever other specific date you want).

Also, when you do deprecate the workflows, would it lead to a failed github action, or just no action taking place?

[k-doering-NOAA]

@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]

@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: pfmc-assessments/PEPtools@10eddd1.

[k-doering-NOAA]

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.