easystats / workflows

GitHub Actions for {easystats} packages
https://indrajeetpatil.github.io/preventive-r-package-care
Creative Commons Zero v1.0 Universal
10 stars 1 forks source link

Rename `render-readme` workflow to `check-readme` #3

Closed IndrajeetPatil closed 2 years ago

IndrajeetPatil commented 2 years ago

In light of discussion here, the scope of this workflow has changed now.

Before, we wanted to use it to make sure that:

The second was never working, and given that we protect the main branch, it never will.

So, its only job now is to make sure that the new commit/PR doesn't break the README.

@easystats/core-team Please make a note.

This means that any time you make a change to README.Rmd, you should also knit it and update README.md as well.