search

rossjrw / pr-preview-action

GitHub Action that deploys a pull request preview to GitHub Pages, similar to Vercel and Netlify, and cleans up after itself.
https://github.com/marketplace/actions/deploy-pr-preview
MIT License
267 stars 43 forks source link

Cleanup does not remove .nojekyll file #15

Open EndBug opened 2 years ago

EndBug commented 2 years ago

Hi, thanks for the awesome action! I was just testing it on a repo and I found out that when the PR is closed the preview is correctly removed, but a .nojekyll file hangs around in the directory. Do you know why?

Here are some links:

Thanks for the help ❤️

rossjrw commented 2 years ago

Funnily enough, I can think of a reason why. This is behaviour specific to JamesIves/github-pages-deploy-action, which this action uses under the hood. JamesIves' action is intended for traditional single-site deployments, and intentionally does not remove CNAME and .nojekyll files during its clean process.

You can see the reasoning here: https://github.com/JamesIves/github-pages-deploy-action/issues/354

However, for a removed preview, these files are definitely not useful, so this action should take care of removing them as well. Therefore I'm going to consider this a bug.

It'll be a while before I can get around to working on this again, so in the meantime you might have some luck with detecting the preview path yourself and adding an extra step to your removal workflow to delete those files. Or, if you feel comfortable with it, I'd gladly accept a PR.

EndBug commented 2 years ago

Related: https://github.com/JamesIves/github-pages-deploy-action/discussions/1210