bootspring_upgrade

Check for updates and manage Bootspring versions.

Overview#

The bootspring_upgrade tool helps you stay up-to-date with the latest Bootspring releases. Check for updates, view changelogs, and manage version upgrades.

Parameters#

ParameterTypeRequiredDescription
actionstringYesAction: check, changelog, info
versionstringNoSpecific version to query
optionsobjectNoAdditional options

Actions#

ActionDescription
checkCheck for available updates
changelogView version changelog
infoGet version information

Options Object#

OptionTypeDefaultDescription
includePrereleasebooleanfalseInclude pre-release versions
detailedbooleanfalseInclude detailed release notes

Usage Examples#

Check for Updates#

Use the bootspring_upgrade tool with: - action: "check"

Response:

Loading code block...

No Update Available#

Use the bootspring_upgrade tool with: - action: "check"

Response:

Loading code block...

View Changelog#

Use the bootspring_upgrade tool with: - action: "changelog" - version: "1.2.0"

Response:

Loading code block...

Version Information#

Use the bootspring_upgrade tool with: - action: "info"

Response:

Loading code block...

Include Prereleases#

Use the bootspring_upgrade tool with: - action: "check" - options: { includePrerelease: true }

Response:

Loading code block...

Response Format#

Success Response#

Loading code block...

Error Response#

Loading code block...

Version Numbering#

Bootspring follows semantic versioning:

FormatDescriptionExample
MAJOR.MINOR.PATCHStable release1.2.0
MAJOR.MINOR.PATCH-beta.NBeta release1.3.0-beta.1
MAJOR.MINOR.PATCH-alpha.NAlpha release2.0.0-alpha.1

When to Upgrade#

TypeContainsUpgrade Strategy
Patch (x.x.1)Bug fixesSafe, upgrade immediately
Minor (x.1.x)New featuresReview changelog, upgrade soon
Major (1.x.x)Breaking changesRead migration guide, plan upgrade

CLI Integration#

Manage upgrades from the command line:

Loading code block...

Upgrade Process#

Standard Upgrade#

Loading code block...

Major Version Upgrade#

Loading code block...

Notifications#

Automatic Checks#

Bootspring checks for updates periodically and shows notifications:

┌────────────────────────────────────────┐ │ Bootspring update available: 1.2.0 │ │ Run: npm update @girardmedia/bootspring│ └────────────────────────────────────────┘

Disable Notifications#

To disable update notifications:

Loading code block...

Security Updates#

Security updates are flagged in the check response:

Loading code block...

Troubleshooting#

Update Check Fails#

If update checks fail:

  1. Check network connectivity
  2. Verify npm registry access
  3. Try: npm ping

Upgrade Issues#

If upgrade causes issues:

  1. Check the changelog for breaking changes
  2. Run bootspring doctor to diagnose
  3. Roll back if needed: npm install @girardmedia/bootspring@previous-version

Version Conflicts#

If you have version conflicts:

Loading code block...