PSA: If you're using gh-pages to host your CI-generated documentation, make sure you don't store any history for that branch

• rust

  2,682 92,831 10.0 Rust

  Empowering everyone to build reliable and efficient software.

  

As it appears, Smithay is kinda hitting a few bad cases so that rustdoc output ends up pretty large: the target/doc/ folder we serve on github pages is ~220 MB in size. Keeping git history on such large content, generating huge diffs at each commit, really made the git repo blow up both in disk size and in processing time required to clone it.

• actions-gh-pages

  14 4,421 8.8 TypeScript

  GitHub Actions for GitHub Pages 🚀 Deploy static files and publish your site easily. Static-Site-Generators-friendly.

As a first-step measure, we changed the CI script to overwrite the gh-pages branch at every run, rather than just appending a new commit. We use this gh-pages action, so it was just a matter of adding a force_orphan: true parameter.

• WorkOS

  workos.com sponsored

  The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

  

• old-docs

  1 1 5.8 HTML

  Discontinued Auto-generated doc mirror. Not interesting for humans.

  

Or do you mean that you have branch gh-pages in the same repository as the source code, which is then cloned by every user? It can make sense to move generated docs to a separate repo. Not only would that solve the problem you're describing, but you could also tweak other settings independently (deployed URL, permissions, etc.). Furthermore, your development repo's branches are not cluttered by CI-managed stuff. That's how I did it for godot-rust.

• deploy-pages

  3 554 8.8 JavaScript

  GitHub Action to publish artifacts to GitHub Pages for deployments

  

There's an ongoing beta to make GitHub pages deployments from actions without pushing to a branch: https://github.com/actions/deploy-pages

Suggest a related project