Sponsored Content
Skip to content

fix: Stop committing generated docs to prevent repo bloat - #6474

Merged
legleux merged 2 commits into
developfrom
legleux/update-docs
Mar 5, 2026
Merged

fix: Stop committing generated docs to prevent repo bloat#6474
legleux merged 2 commits into
developfrom
legleux/update-docs

Conversation

@legleux

@legleux legleux commented Mar 4, 2026

Copy link
Copy Markdown
Contributor

High Level Overview of Change

The peaceiris/actions-gh-pages action commits the built files to the repo's gh-pages branch which has been bloating the repo.
This action will not do that.

Context of Change

There was 9 months of broken docs publishing before #5661 re-introduced docs building at and as development has accelerated the problem has grown.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)

@legleux
legleux requested review from bthomee and ximinez March 4, 2026 16:11
@bthomee
bthomee requested a review from mathbunnyru March 4, 2026 16:50

@mathbunnyru mathbunnyru left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.
But in Clio we also call actions/configure-pages, could you please check if it's needed or not?

@legleux

legleux commented Mar 4, 2026

Copy link
Copy Markdown
Contributor Author

Looks good. But in Clio we also call actions/configure-pages, could you please check if it's needed or not?

Does that do something more we need? I may have done something in my repo ages ago but I didn't do anything special other than making sure "Source" was set to "GitHub Actions" in (my repo's) settings.

Is that part of what it handles? If not, then we do need to make sure https://github.com/XRPLF/rippled/settings/pages "Source" is set to "GitHub Actions". @bthomee

This action ran like this and produced: https://legleux.github.io/rippled/ (which is responsive to your system's theme apparently?!?) 😮

@bthomee

bthomee commented Mar 4, 2026

Copy link
Copy Markdown
Collaborator

Is that part of what it handles? If not, then we do need to make sure https://github.com/XRPLF/rippled/settings/pages "Source" is set to "GitHub Actions". @bthomee

It's currently set to "Deploy from a branch" with gh-pages as the branch. It's an easy change, just let me know if I should make it.

@legleux

legleux commented Mar 5, 2026

Copy link
Copy Markdown
Contributor Author

Is that part of what it handles? If not, then we do need to make sure https://github.com/XRPLF/rippled/settings/pages "Source" is set to "GitHub Actions". @bthomee

It's currently set to "Deploy from a branch" with gh-pages as the branch. It's an easy change, just let me know if I should make it.

Yes the goal is to stop using the gh-pages branch and my suggestion is to completely obliterate it from the entire repository's history.

I changed the source of documentation deployment. We can merge this now.

@legleux
legleux requested a review from mathbunnyru March 5, 2026 03:03
@legleux
legleux merged commit 7751839 into develop Mar 5, 2026
1 check passed
@legleux
legleux deleted the legleux/update-docs branch March 5, 2026 03:19
@mvadari mvadari added this to the 3.2.0 milestone May 20, 2026
beartec-jpg pushed a commit to beartec-jpg/FalconLedger that referenced this pull request Jun 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants