Remove old GitHub Pages commits to reduce repo size #3321
Merged
Conversation
This file contains 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
This repository uses GitHub Actions to automatically build and publish the docs to GitHub Pages. Deploying to GitHub Pages involves pushing a commit of the built site to the `gh-pages` branch. We use the third-party GitHub Action `peaceiris/actions-gh-pages@v3` to handle this for us. This commit sets the config option `force_orphan: true` on `peaceiris/actions-gh-pages@v3`, which will cause new commits to `gh-pages` to be orphaned. Old build commits will therefore no longer belong to the `gh-pages` branch. This should result in future fetches and clones of the repo ignoring or garbage collecting those dangling commits. Currently the `gh-pages` branch sits at around ~10k builds, so this change should enable a fairly significant size reduction for the repo.
ChrisBAshton
approved these changes
Nov 30, 2021
This was referenced Nov 30, 2021
Sign up for free
to 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.
This repository uses GitHub Actions to automatically build and publish the docs to GitHub Pages.
Deploying to GitHub Pages involves pushing a commit of the built site to the
gh-pagesbranch. We use the third-party GitHub Actionpeaceiris/actions-gh-pages@v3to handle this for us.This commit sets the config option
force_orphan: trueonpeaceiris/actions-gh-pages@v3, which will cause new commits togh-pagesto be orphaned.Old build commits will therefore no longer belong to the
gh-pagesbranch. This should result in future fetches and clones of the repo ignoring or garbage collecting those dangling commits.Currently the
gh-pagesbranch sits at around ~10k builds, so this change should enable a fairly significant size reduction for the repo.