Commit README once it it rendered

[etiennebacher]

Related to https://github.com/easystats/easystats/issues/278. The GHA renders the README but doesn't commit the change, maybe this is why it isn't automatically updated?

[IndrajeetPatil]

We can try with this. I had adapted this action from here, and they don't do git add either.

https://github.com/r-lib/actions/blob/7dbac86d823c2ead41a503457cde1f13c7891263/examples/render-rmarkdown.yaml#L26-L33

[IndrajeetPatil]

Let's see if it works: https://github.com/easystats/easystats/runs/8152895788?check_suite_focus=true

[etiennebacher]

We can try with this. I had adapted this action from here, and they don't do git add either.

They don't do "git add" because they put the new markdown file in "git commit" whereas we don't:

https://github.com/r-lib/actions/blob/7dbac86d823c2ead41a503457cde1f13c7891263/examples/render-rmarkdown.yaml#L32

[IndrajeetPatil]

Gotcha!

[IndrajeetPatil]

I don't think this is going to work because when we knit the README.Rmd, it typically produces changes to also included plots, etc., and we are committing only the .md file. So, even if this were to work, all side effects produced during rendering will be out of date.

[IndrajeetPatil]

See, e.g., https://github.com/easystats/easystats/runs/8152895788?check_suite_focus=true#step:8:1

[etiennebacher]

So should we use "git add ." instead?

[IndrajeetPatil]

We can try. It will work, but we should just make sure that nothing that we are not creating isn't committed (e.g. /renv folder created by GHA).

[IndrajeetPatil]

Let's check with the new one: https://github.com/easystats/easystats/runs/8153333877?check_suite_focus=true

[etiennebacher]

I tested locally and "git add man/figures/*.png README.md" correctly captures new png in man/figures and the new readme. Are there other special files that are modified in general?

[IndrajeetPatil]

Okay, let's use this more specific approach.

I am trying it here: https://github.com/easystats/easystats/runs/8153418094?check_suite_focus=true

[etiennebacher]

All these tests have to fail because easystats/easystats doesn't use the workflows from easystats/workflows 😅

[IndrajeetPatil]

NOOOOOOOO LMAO, so dumb

[etiennebacher]

I can update the GHA in easystats/easystats

[etiennebacher]

hum, easystats needs a lot of extra packages in the readme (deepdep, miniCRAN, etc.). Maybe we can let the render-readme GHA as before and just add the fix with "git add" there?

[IndrajeetPatil]

I agree. easystats will need to be dealt differently for render README workflow.

[etiennebacher]

Done

[etiennebacher]

Ok so we can add files but the commit cannot be pushed automatically because the branch "main" is protected:

https://github.com/easystats/easystats/runs/8154484139?check_suite_focus=true#step:8:19