Improve error handling for GitHub Pages is disabled (especially forks)
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- github-actions, javascript
Research direction
Start by reproducing the linked workflow run and trace the deploy step through src/index.js, src/internal/deployment.js, and src/internal/api-client.js, which appear in the reported stack trace. Done means failures for disabled Pages, especially forks, produce one readable and actionable message or step summary without redundant error annotations, while retaining useful technical details.
Written by the indexing model from the issue text.
Description
Here's a fairly typical run:
https://github.com/jsoref/trippy/actions/runs/12583591554
Annotations
3 errors and 2 warnings
deploy
Creating Pages deployment failed
HttpError: Not Found
at /home/runner/work/_actions/actions/deploy-pages/v4/node_modules/@octokit/request/dist-node/index.js:124:1
at processTicksAndRejections (node:internal/process/task_queues:95:5)
at createPagesDeployment (/home/runner/work/_actions/actions/deploy-pages/v4/src/internal/api-client.js:125:1)
at Deployment.create (/home/runner/work/_actions/actions/deploy-pages/v4/src/internal/deployment.js:74:1)
at main (/home/runner/work/_actions/actions/deploy-pages/v4/src/index.js:30:1)
Error: Failed to create deployment (status: 404) with build version a1ea16db01f25d44559533ab7018626dca0205d2. Request ID 8881:29425A:2B2F8E0:5630B9F:67769CBB Ensure GitHub Pages has been enabled: https://github.com/jsoref/trippy/settings/pages
If this is expected outcome for anyone who forks a repository that uses this action to get a failure, it'd be nice if it was a single pretty failure. If it is too long to fit into a single error box, then it'd be better for it to not have any error boxes and use a github step summary instead.
What this action is doing today is generating 3 error boxes:
- Mostly content free
- Incredibly long and not terribly helpful
- Hard to read (because it doesn't use line feeds) and buries the main problem behind a bunch of very long hex runs
Ideally the second wouldn't be present if the system can determine that GitHub Pages aren't enabled. And ideally the first and last would be unified into a single message:
GitHub Pages does not appear to be enabled.
Visit https://github.com/$GITHUB_REPOSITORY/settings/pages and ensure
- Source: Deploy from a branch
- Branch: $GITHUB_BRANCH
Technical details:
Failed to create deployment (status: 404) for $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/commit/$GITHUB_SHA.
Request ID: $REQUEST_ID
(where $GITHUB_SERVER_URL, $GITHUB_REPOSITORY, $GITHUB_SHA and $GITHUB_BRANCH are filled in appropriately based on the current run... and $REQUEST_ID is whatever that random set of hex runs is...)
Note that using a url instead of a random hex run improves readability.
- Dominant language
- JavaScript
- Stars
- 967
- Forks
- 147
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from actions/deploy-pages
-
Difficulty 4/5 3-5 days Newbie friendliness 55/100
actions/deploy-pages#454 · 1 comment ·
-
Intermittent "No artifacts named github-pages" when deploy-pages runs right after upload-pages-artifact in the same jobPossibly taken @neilime claimed this 7 days ago. Open
Difficulty 4/5 3-5 days Newbie friendliness 52/100
actions/deploy-pages#451 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
actions/deploy-pages#435 · 3 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 65/100
actions/deploy-pages#434 · 3 comments · 1 reaction ·
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
actions/deploy-pages#418 · 19 comments · 12 reactions ·
All issues in actions/deploy-pages
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 66/100
Maintainers usually reply within 1 day
-
check:passed logos:edit
Difficulty 1/5 Under an hour Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
db-d1-sqlite: upsert is aliased to updateOne, so payload.kv.set never inserts new keysPossibly taken @pcbeingused333 claimed this today. OpenBug db: d1-sqlite Payload OSS
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
payloadcms/payload#19766 ·
Maintainers usually reply within 1 day
-
Type: Bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
inverse-inc/packetfence#9707 ·
Maintainers usually reply within 1 day
-
feedback simulation workshop
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
githubnext/gh-aw-workshop#5896 ·
Maintainers usually reply within 1 day