- Notifications
You must be signed in to change notification settings - Fork27k
docs: clarify 404.html setup for GitHub Pages in deployment guide#66162
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
EswarBalasubramanian wants to merge1 commit intoangular:mainChoose a base branch
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Open
docs: clarify 404.html setup for GitHub Pages in deployment guide#66162
EswarBalasubramanian wants to merge1 commit intoangular:mainfromEswarBalasubramanian:fix-gh-pages-docs
+23 −0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number:#49128
The deployment guide instructs users to "configure the fallback route or 404 page to
index.html" for GitHub Pages, but doesn't warn against a common pitfall: manually copyingindex.htmlto404.html. This approach fails silently because Angular CLI injects dynamic script references with content hashes (e.g.,main.abc123.js) that change on every build, leading to blank pages on deep links or page refreshes.What is the new behavior?
The documentation now includes:
index.htmlto404.htmlis error-prone and defeats cache-bustingangular-cli-ghpageswhich handles 404 fallback automatically viang deploypathSegmentsToKeepfor project sitesDoes this PR introduce a breaking change?
Other information
This change helps developers avoid a common mistake when deploying Angular apps to GitHub Pages, especially those new to SPA hosting on static file servers.