Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
mwoehlke opened this issue May 2, 2024 · 2 comments
Open

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

mwoehlke opened this issue May 2, 2024 · 2 comments

Comments

@mwoehlke
Copy link

mwoehlke commented May 2, 2024

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
Copy link
Contributor

Don't hesitate to open a PR!

@TheDevelolper
Copy link

TheDevelolper commented May 12, 2024

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:

...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants
@mwoehlke @TheDevelolper @yoannchaudet and others