sitemap.xml build artifact breaks git pull

[foofoodog]

Trying to do a git pull after a git clean -fxd, getting this, assuming it should be in .gitignore.
error: Your local changes to the following files would be overwritten by merge:
apps/web/public/sitemap.xml
Please commit your changes or stash them before you merge.
Aborting

[freddysae0]

What's happening:

• apps/web/public/sitemap.xml is tracked in Git, but it's also a build output. scripts/build-guide.mjs rewrites it, and that script runs as npm run guide from both predev and prebuild. So npm run dev/npm run build regenerate it.
• At some commits the committed sitemap is older than the guide it's generated from, so building leaves it modified. I checked a few recent ones: building at af403c6b~1 changes it by about 1,270/870 lines, and at a685f1ac~1 by 342 lines. When a later commit also changes sitemap.xml, git pull refuses to overwrite your local version.
• git clean -fxd doesn't help, because it only deletes untracked/ignored files. It never reverts changes to tracked files.

I reproduced exactly your error (Your local changes to the following files would be overwritten by merge: apps/web/public/sitemap.xml) and this fixes it:

git restore apps/web/public/sitemap.xml     # or: git checkout -- apps/web/public/sitemap.xml
git pull

To throw away all local build changes to tracked files before updating, use git reset --hard (careful: it discards your own edits too) followed by git clean -fxd. Note it's reset --hard that reverts tracked files.

It's regenerated on the next dev/build anyway, so nothing is lost by restoring it.

For the maintainers: since it's generated on every build, either stop tracking it (.gitignore it and git rm --cached apps/web/public/sitemap.xml, letting the deploy build produce it) or keep regenerating it in the same commit as guide changes, so a fresh build at any commit matches what's committed.

[foofoodog]

@freddysae0 Thanks for the assistance and verbose AI scented write up. I, perhaps wrongly, figured my one sentence report might give the devs enough to go on.

[henmedia]

@foofoodog thank you for the report, and @freddysae0 thank you for the clear explanation, it is exactly right: the file is built on every npm run dev and npm run build, but it was also kept in Git. I stopped tracking it: it is now in .gitignore and the build creates it, the same way as the other generated guide files. It will come with the next release.

One time you may still hit the error after that: if your copy of apps/web/public/sitemap.xml is changed, run git restore apps/web/public/sitemap.xml and then git pull. After that it does not come back.

@freddysae0 if you'd like to support the project, a small donation is very welcome.

[henmedia]

@foofoodog, it is out in 1.87.0: sitemap.xml is no longer kept in Git, so a tree that has been built can pull again. Thanks also to @freddysae0 for the clear explanation. Reload the page to get it; the installed app needs a restart.