Skip to content

update examples/README.md to include latest changes to example yamls#689

Merged
gaborcsardi merged 1 commit intor-lib:v2-branchfrom
dpprdan:fix/update_examples_readme
Jan 15, 2023
Merged

update examples/README.md to include latest changes to example yamls#689
gaborcsardi merged 1 commit intor-lib:v2-branchfrom
dpprdan:fix/update_examples_readme

Conversation

@dpprdan
Copy link
Copy Markdown
Contributor

@dpprdan dpprdan commented Jan 15, 2023

The https://github.com/r-lib/actions/blob/v2-branch/examples/README.md is missing some of the recent changes to the example workflows. This updates it from the https://github.com/r-lib/actions/blob/v2-branch/examples/README.Rmd.

Seeing that re-rendering is apparently easily missed and to reduce mental load, should there either be a pre-commit hook (cf. use_readme_rmd()) or an GHA that updates the README.md when there is a change to the Rmd or the yaml files? (I think I'd prefer the GHA).

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Jan 15, 2023

Codecov Report

Merging #689 (cc7e7fa) into v2-branch (105dd10) will not change coverage.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           v2-branch      #689   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
===========================================
  Files              2         2           
  Lines             10        10           
===========================================
  Hits              10        10

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@gaborcsardi
Copy link
Copy Markdown
Member

gaborcsardi commented Jan 15, 2023

Thanks! Maybe we should just remove these from the README, they are in the workflow file, after all, that's the one you should copy.

@gaborcsardi gaborcsardi merged commit 51716de into r-lib:v2-branch Jan 15, 2023
@dpprdan
Copy link
Copy Markdown
Contributor Author

dpprdan commented Jan 15, 2023

OT what's necessary to have @codecov-commenter comment on the coverage? I have the test-coverage workflow enabled, but don't get those comments (e.g. here ropensci/opencage#153). I vaguely remember that there used to be a lint-bot as well, but haven't seen that in a while either.

@dpprdan
Copy link
Copy Markdown
Contributor Author

dpprdan commented Jan 15, 2023 •
edited
Loading

Maybe we should just remove these from the README

"these" meaning the yamls? But aren't those used by usethis (i.e. those are what is pulled by use_github_action*() functions)?

Sorry, I think I misread. You mean remove the content of the yamls from the README, not removing the yaml files.

@dpprdan dpprdan deleted the fix/update_examples_readme branch January 15, 2023 16:07
@github-actions
Copy link
Copy Markdown

github-actions bot commented Jan 30, 2023

This pull request has been automatically locked. If you believe you have found a related problem, please file a new issue and include a link to this pull request.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 30, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dpprdan @codecov-commenter @gaborcsardi