Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bug(docs,ci): gh-pages fail to deply; search index > 100 MB #1291

Closed
danceratopz opened this issue Mar 10, 2025 · 1 comment · Fixed by #1292
Closed

bug(docs,ci): gh-pages fail to deply; search index > 100 MB #1291

danceratopz opened this issue Mar 10, 2025 · 1 comment · Fixed by #1292
Assignees
Labels
scope:ci Scope: Continuous Integration scope:docs Scope: Documentation type:bug Something isn't working

Comments

@danceratopz
Copy link
Member

Deploying docs upon merge to main is currently failing as the site's search index exceeds Githubs file size limit.

error: failed to push branch gh-pages to origin: "remote: error: Trace: 6f89850c61b6b63aa429f53853465888a0bf13f6d6be1bb41b10446c6ce1c59f        
remote: error: See https://gh.io/lfs for more information.        
remote: error: File main/search/search_index.json is 122.77 MB; this exceeds GitHub's file size limit of 100.00 MB        
remote: error: GH001: Large files detected. You may want to try Git Large File Storage - https://git-lfs.github.com./
@danceratopz danceratopz added scope:ci Scope: Continuous Integration scope:docs Scope: Documentation type:bug Something isn't working labels Mar 10, 2025
@danceratopz danceratopz self-assigned this Mar 10, 2025
@danceratopz
Copy link
Member Author

This (or block exclusion) would have been preferable, but couldn't get it to work (even though we use the attr_list extension, see: https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#excluding-sections)

## Function Source Code {{ '{ data-search-exclude }' }}

::: {{ package_name }}
    options:
        filters: ["^[tT]est*|^Spec*"]

So went with skipping the whole page for functions. Function names remain searchable, but only on test module summary pages:

@danceratopz danceratopz changed the title bug(docs,ci): bug(docs,ci): gh-pages fail to deply; search index > 100 Mb Mar 10, 2025
@danceratopz danceratopz changed the title bug(docs,ci): gh-pages fail to deply; search index > 100 Mb bug(docs,ci): gh-pages fail to deply; search index > 100 MB Mar 10, 2025
spencer-tb pushed a commit that referenced this issue Mar 10, 2025
* chore(docs): don't include function pages in site search index #1291

* docs: update changelog
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope:ci Scope: Continuous Integration scope:docs Scope: Documentation type:bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant