ProjectPythia / cookbook-actions

Reusable workflows used by Project Pythia Cookbooks
Apache License 2.0
2 stars 7 forks source link

PR previews have undesired side effect for main page (deleted html pages are persisting) #120

Open jbusecke opened 2 days ago

jbusecke commented 2 days ago

I am tracking an issue with our docs over at LEAP here. We just noticed that the deployment branch retains html files which are not currently part of the book anymore!

I figure this is due to the setting here which I think is necessary for the preview to work.

I think the desired solution here would be to specify a directory (/preview) that is retained, while all other files represent a current commit? It seems that this has been brought up as feature request upstream (https://github.com/peaceiris/actions-gh-pages/issues/718 and https://github.com/peaceiris/actions-gh-pages/issues/771) but is not currently implemented.

Wondering what folks here think about this? This seems like a pretty bad behavior to me (and has caused some major confusion with our users), so I would be willing to implement a custom solution until an upstream solution is available. But I think such a solution should definitely live here?

jbusecke commented 2 days ago

I just saw this which might be a possible solution!