Add error message for file permissions

[tsusdere]

part of: https://github.com/github/pages-engineering/issues/2428

Add an error message for when incorrect file permissions could be the cause for deployment failures.

[DCNick3]

I am hitting this error in my recent rustdoc deployments: https://github.com/DCNick3/shin/actions/runs/5300334374/jobs/9593874612

Is there anywhere I can find details about the "incorrect file permissions"?

[rami3l]

I am encountering this problem as well.

Here's the log...

2023-07-19T05:37:47.0518637Z Requested labels: ubuntu-latest
2023-07-19T05:37:47.0518919Z Job defined at: rami3l/pacaptr/.github/workflows/docs.yml@refs/heads/master
2023-07-19T05:37:47.0519015Z Waiting for a runner to pick up this job...
2023-07-19T05:37:47.2445828Z Job is waiting for a hosted runner to come online.
2023-07-19T05:37:50.4001879Z Job is about to start running on the hosted runner: GitHub Actions 2 (hosted)
2023-07-19T05:37:52.9022422Z Current runner version: '2.306.0'
2023-07-19T05:37:52.9051210Z ##[group]Operating System
2023-07-19T05:37:52.9051857Z Ubuntu
2023-07-19T05:37:52.9052182Z 22.04.2
2023-07-19T05:37:52.9052467Z LTS
2023-07-19T05:37:52.9052891Z ##[endgroup]
2023-07-19T05:37:52.9053247Z ##[group]Runner Image
2023-07-19T05:37:52.9053636Z Image: ubuntu-22.04
2023-07-19T05:37:52.9053950Z Version: 20230710.1.0
2023-07-19T05:37:52.9054535Z Included Software: https://github.com/actions/runner-images/blob/ubuntu22/20230710.1/images/linux/Ubuntu2204-Readme.md
2023-07-19T05:37:52.9055362Z Image Release: https://github.com/actions/runner-images/releases/tag/ubuntu22%2F20230710.1
2023-07-19T05:37:52.9055819Z ##[endgroup]
2023-07-19T05:37:52.9056201Z ##[group]Runner Image Provisioner
2023-07-19T05:37:52.9056595Z 2.0.238.1
2023-07-19T05:37:52.9056883Z ##[endgroup]
2023-07-19T05:37:52.9057669Z ##[group]GITHUB_TOKEN Permissions
2023-07-19T05:37:52.9058298Z Contents: read
2023-07-19T05:37:52.9058666Z Metadata: read
2023-07-19T05:37:52.9059250Z Pages: write
2023-07-19T05:37:52.9059680Z ##[endgroup]
2023-07-19T05:37:52.9064116Z Secret source: Actions
2023-07-19T05:37:52.9064722Z Prepare workflow directory
2023-07-19T05:37:52.9955145Z Prepare all required actions
2023-07-19T05:37:53.0149496Z Getting action download info
2023-07-19T05:37:53.2488149Z Download action repository 'actions/deploy-pages@v2' (SHA:12ab2b16cf43a7a061fe99da74b6f8f11fb77f5b)
2023-07-19T05:37:53.9807938Z Complete job name: deploy
2023-07-19T05:37:54.0741312Z ##[group]Run actions/deploy-pages@v2
2023-07-19T05:37:54.0741739Z with:
2023-07-19T05:37:54.0742301Z   token: ***
2023-07-19T05:37:54.0742588Z   timeout: 600000
2023-07-19T05:37:54.0742859Z   error_count: 10
2023-07-19T05:37:54.0743139Z   reporting_interval: 5000
2023-07-19T05:37:54.0743467Z   artifact_name: github-pages
2023-07-19T05:37:54.0743777Z   preview: false
2023-07-19T05:37:54.0744033Z env:
2023-07-19T05:37:54.0744289Z   CARGO_TERM_COLOR: always
2023-07-19T05:37:54.0744638Z   CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
2023-07-19T05:37:54.0745048Z ##[endgroup]
2023-07-19T05:37:54.4145201Z Artifact exchange URL: https://pipelines.actions.githubusercontent.com/UDgwt3Wna6q47f6ozDPk212ZhjhHJ01kbwJZwZhsF79t9FOAtF/_apis/pipelines/workflows/5595433732/artifacts?api-version=6.0-preview
2023-07-19T05:37:54.4715638Z Creating Pages deployment with payload:
2023-07-19T05:37:54.4716078Z {
2023-07-19T05:37:54.4717364Z 	"artifact_url": "https://pipelines.actions.githubusercontent.com/UDgwt3Wna6q47f6ozDPk212ZhjhHJ01kbwJZwZhsF79t9FOAtF/_apis/pipelines/1/runs/3881/artifacts?artifactName=github-pages&%24expand=SignedContent",
2023-07-19T05:37:54.4718198Z 	"pages_build_version": "d35a2b64234c000f1fcb4fd4a45b0dc903b524d8",
2023-07-19T05:37:54.4816714Z 	"oidc_token": "***"
2023-07-19T05:37:54.4817049Z }
2023-07-19T05:37:54.8511074Z Created deployment for d35a2b64234c000f1fcb4fd4a45b0dc903b524d8, ID: d35a2b64234c000f1fcb4fd4a45b0dc903b524d8
2023-07-19T05:37:59.8777142Z Getting Pages deployment status...
2023-07-19T05:38:00.1569657Z ##[error]Deployment failed, Please ensure that the file permissions are correct.
2023-07-19T05:38:00.1907372Z Evaluate and set environment url
2023-07-19T05:38:00.1912322Z Evaluated environment url: https://rami3l.github.io/pacaptr/
2023-07-19T05:38:00.1912852Z Cleaning up orphan processes

---

Update: For my case, the fix was following https://github.com/actions/upload-pages-artifact#file-permissions.