README incorrectly claims deploy-pages needs a gzipped tarball

actions / upload-pages-artifact

A composite action for packaging and uploading an artifact that can be deployed to GitHub Pages.

https://pages.github.com

MIT License

310 stars 74 forks source link

README incorrectly claims deploy-pages needs a gzipped tarball #101

Open mwoehlke opened 6 months ago

mwoehlke commented 6 months ago

As previously mentioned here:

I was struggling with why deploy-pages was rejecting my artifact, and it turns out it is because I was following the README and gzip-compressing my tarball. Removing that step resolved the issue. [...] Deploy-pages expects a zip containing an uncompressed tar.

Please update the misleading README. It should not mention "gzip", and it should note that upload-artifact, used internally, creates a zip for you.

yoannchaudet commented 6 months ago

Don't hesitate to open a PR!

TheDevelolper commented 6 months ago

I think it says if you DO NOT choose to use this plugin.

While choosing to use this action as part of your approach to deploying to GitHub Pages is technically optional, we highly recommend it since it takes care of producing (mostly) valid artifacts.

However, if you do not choose to use this action but still want to deploy to Pages using an Actions workflow, then you must upload an Actions artifact that meets the following criteria:

...