Skip to content

Rename BSK-SDK wheels from plugins to extensions#1475

Merged
schaubh merged 9 commits into
developfrom
feature/bsk_extension_naming
Jul 12, 2026
Merged

Rename BSK-SDK wheels from plugins to extensions#1475
schaubh merged 9 commits into
developfrom
feature/bsk_extension_naming

Conversation

@schaubh

@schaubh schaubh commented Jul 10, 2026

Copy link
Copy Markdown
Contributor
  • Review: By commit
  • Merge strategy: Merge (no squash)

Description

This PR adopts Extension as the term for out-of-tree modules and messages built with bsk-sdk. Extensions expand Basilisk through independently built Python wheels while remaining distinct from future IPC-based plugins.

The documentation now:

  • Renames the Plugins documentation section to Extensions and updates navigation, links, release notes, and known issues.
  • Rewrites the extension overview, installation guide, and authoring quick start for novice developers.
  • Explains extension ownership, build isolation, custom messages, ABI compatibility, testing, packaging, and troubleshooting.
  • Reorganizes the Basilisk and BSK-SDK release guides around major, patch, beta, and release-candidate workflows with shared tasks.
  • Modernizes the integrated external-module guide and clarifies when it should be used instead of an Extension.
  • Cleans generated cache and macOS metadata from the downloadable external-module example archive.

Verification

  • Built the complete documentation with warnings treated as errors.
  • Verified the cleaned External.zip archive with unzip -t.
  • No native Basilisk code was changed.

Documentation

Updates the Extension, integrated external-module, installation, release, known-issues, and release-note documentation.

Future work

Development of IPC-based plugins remains separate future work.

@schaubh schaubh self-assigned this Jul 10, 2026
@schaubh schaubh requested a review from a team as a code owner July 10, 2026 22:05
@schaubh schaubh added the documentation Improvements or additions to documentation label Jul 10, 2026
@schaubh schaubh added this to Basilisk Jul 10, 2026
@schaubh schaubh moved this to 👀 In review in Basilisk Jul 10, 2026
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

schaubh added a commit that referenced this pull request Jul 11, 2026
…eels

We are going to use the term plug-in for a more general BSK expansion in the future.  The term extension makes more sense as this BSK-SDK wheel is a true extension of the BSK modules.  The extension can build on BSK base classes and tools to create its own modules.
schaubh added a commit that referenced this pull request Jul 11, 2026
schaubh added a commit that referenced this pull request Jul 11, 2026
Document beta-cycle BSK-SDK testing against Basilisk develop and nightly wheels.
Clarify that tools/sync_all.py now stamps both src/bsk_sdk/_bsk_version.txt and
the SDK package version in pyproject.toml, and remove the old manual package
version update steps from the major and patch release flows.

Discuss option to sync with existing BSK clone copy
schaubh added a commit that referenced this pull request Jul 11, 2026
Changed the sections to have less duplicated code examples.  Presentation is now more compact and more educational.
@schaubh schaubh force-pushed the feature/bsk_extension_naming branch from c42adaf to 93b031a Compare July 11, 2026 03:39
schaubh added a commit that referenced this pull request Jul 11, 2026
@schaubh schaubh requested a review from ReeceHumphreys July 11, 2026 03:40
schaubh added a commit that referenced this pull request Jul 11, 2026
@schaubh schaubh force-pushed the feature/bsk_extension_naming branch from 93b031a to 2f441a1 Compare July 11, 2026 15:51
schaubh added a commit that referenced this pull request Jul 11, 2026
@schaubh schaubh force-pushed the feature/bsk_extension_naming branch from 2f441a1 to b268cca Compare July 11, 2026 17:58
schaubh added 9 commits July 12, 2026 11:15
…eels

We are going to use the term plug-in for a more general BSK expansion in the future.  The term extension makes more sense as this BSK-SDK wheel is a true extension of the BSK modules.  The extension can build on BSK base classes and tools to create its own modules.
Document beta-cycle BSK-SDK testing against Basilisk develop and nightly wheels.
Clarify that tools/sync_all.py now stamps both src/bsk_sdk/_bsk_version.txt and
the SDK package version in pyproject.toml, and remove the old manual package
version update steps from the major and patch release flows.

Discuss option to sync with existing BSK clone copy
Changed the sections to have less duplicated code examples.  Presentation is now more compact and more educational.
@schaubh schaubh force-pushed the feature/bsk_extension_naming branch from b268cca to feb9cb0 Compare July 12, 2026 17:15
@schaubh schaubh merged commit 29e5e7d into develop Jul 12, 2026
13 checks passed
schaubh added a commit that referenced this pull request Jul 12, 2026
…eels

We are going to use the term plug-in for a more general BSK expansion in the future.  The term extension makes more sense as this BSK-SDK wheel is a true extension of the BSK modules.  The extension can build on BSK base classes and tools to create its own modules.
schaubh added a commit that referenced this pull request Jul 12, 2026
schaubh added a commit that referenced this pull request Jul 12, 2026
Document beta-cycle BSK-SDK testing against Basilisk develop and nightly wheels.
Clarify that tools/sync_all.py now stamps both src/bsk_sdk/_bsk_version.txt and
the SDK package version in pyproject.toml, and remove the old manual package
version update steps from the major and patch release flows.

Discuss option to sync with existing BSK clone copy
schaubh added a commit that referenced this pull request Jul 12, 2026
Changed the sections to have less duplicated code examples.  Presentation is now more compact and more educational.
schaubh added a commit that referenced this pull request Jul 12, 2026
@schaubh schaubh deleted the feature/bsk_extension_naming branch July 12, 2026 20:31
@github-project-automation github-project-automation Bot moved this from 👀 In review to ✅ Done in Basilisk Jul 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

1 participant