fix(deps): upgrade default template to Bootstrap 5.3.8 - #11103
Open
vicancy wants to merge 21 commits into
Open
Conversation
Upgrade NuGet, npm, and GitHub Actions dependencies and migrate affected APIs and templates. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Avoid shared registry collisions when schema tests and document builds run concurrently. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Capture separate member pages and updated PDF output from the dependency migrations. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Normalize repository paths and compiler-generated source locations across CI platforms. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Use an explicit update flag so Verify accepts snapshots only in the snapshot workflow. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Regenerate PDF snapshots on the canonical Ubuntu snapshot workflow. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Keep platform-specific browser PDF layout out of macOS and Windows snapshot comparisons. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Replace the broad breaking-version sweep with vulnerability remediations only. Bootstrap moves to 5.3.8 because no patched Bootstrap 3 release exists; other breaking majors remain unchanged. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Remove the overlapping NuGet update block while retaining daily coverage for Verify packages. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Restore the creator-selected consolidated NuGet, npm, and GitHub Actions upgrade, including major-version migrations and generated snapshots. Retain only compatibility holds proven by restore or peer/runtime failures. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Keep the platform-sensitive PDF and Seed output comparison on the canonical Linux job while other snapshot suites still run on every OS. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Keep only validated npm vulnerability remediations and the required Bootstrap migration; leave NuGet, Actions, and unrelated breaking majors unchanged. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Keep the existing pagination flow with twbs-pagination 1.4.2, migrate statictoc controls and dropdowns, preserve navbar ordering, and replace removed Glyphicon alert icons. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Restore the repository's existing Dependabot policy and document the Bootstrap 3 utility compatibility retained by the Bootstrap 5 security migration. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: c89e7293-53c2-42c4-9127-1d7bd345542f
Explain why the legacy utility rules remain after the Bootstrap 5 security migration. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: c89e7293-53c2-42c4-9127-1d7bd345542f
Remove unrelated npm security upgrades and keep only Bootstrap 5.3.8, twbs-pagination 1.4.2, and their required template compatibility changes. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: c89e7293-53c2-42c4-9127-1d7bd345542f
Bootstrap 5 renders nav lists as wrapping flex rows, so preserve the default template's vertical side-affix layout. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: c89e7293-53c2-42c4-9127-1d7bd345542f
Restore the default and statictoc layout, typography, navigation, filtering, anchors, breakpoints, and footer behavior while using Bootstrap 5 components and APIs. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: c89e7293-53c2-42c4-9127-1d7bd345542f
Drop the Bootstrap 3 visual compatibility layer while retaining functional navbar, TOC, anchor, header, and footer migrations for Bootstrap 5. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: c89e7293-53c2-42c4-9127-1d7bd345542f
This file contains hidden or 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
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.
Summary
twbs-pagination1.3.1 → 1.4.2 for Bootstrap 5page-itemandpage-linkmarkup while retaining the existing search flow.This is an intentional breaking change for custom templates layered on
defaultorstatictoc. Docfx merges templates by file name, with later templates replacing earlier files in full. A custom template that overrides an old Bootstrap 3 partial, stylesheet, or script can therefore combine Bootstrap 3 markup with Bootstrap 5 assets and lose navbar, dropdown, collapse, TOC, or affix behavior.Custom templates need migration if they override files such as:
layout/_master.tmplpartials/navbar.tmpl.partialpartials/toc.tmpl.partialpartials/li.tmpl.partialor dropdown partialsstyles/docfx.cssstyles/docfx.jsCommon Bootstrap 3 → 5 replacements include:
data-toggledata-bs-toggledata-targetdata-bs-target.collapse.in.collapse.show.navbar-toggle.navbar-toggler.navbar-inverse.navbar-dark.bg-dark.pull-right.float-end.hidden-*/.visible-*.d-*utilities.table-condensed.table-smBootstrap 5 no longer exposes Bootstrap components as jQuery plugins. Custom JavaScript using calls such as
$(...).collapse(),$(...).tab(), or$(...).dropdown()must use the Bootstrap 5 APIs. Bootstrap 3 affix and scrollspy assumptions also require migration.Visual assumptions may change because this PR adopts Bootstrap 5 typography, link decoration, table spacing, responsive containers, gutters, breakpoints, blockquotes, navbar, breadcrumbs, and pagination.
Custom templates that are fully standalone, or that only override tokens/localization, preprocessors, data-model extensions, or CSS/JavaScript that does not depend on Bootstrap markup, are not expected to require migration.
Before upgrading, run
docfx template export defaultand reconcile any overridden files with the new Bootstrap 5 versions. This change should be called out in release notes and is best reviewed for a prerelease or explicitly breaking release.Bootstrap 5 preview
Video walkthrough
35-second walkthrough covering desktop styling, Markdown/tables, tabs, Bootstrap components, search/pagination, footer clearance, and mobile navbar/TOC:
bootstrap5-migration-demo.mp4
Screenshots
Expanded screenshots
Native Bootstrap 5 content styling
Bootstrap components
Mobile navigation
Footer clearance
Validation