Skip to content

Replace the term Plugin with Extension#19

Merged
schaubh merged 5 commits into
developfrom
feature/sdk_extension_naming
Jul 12, 2026
Merged

Replace the term Plugin with Extension#19
schaubh merged 5 commits into
developfrom
feature/sdk_extension_naming

Conversation

@schaubh

@schaubh schaubh commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Summary

Rename BSK-SDK’s out-of-tree wheel terminology from “plugin” to “extension” while preserving the existing public CMake API for downstream users.

This updates the documentation, example project, CI labels/artifacts, CMake diagnostics/comments, and tests to use extension naming. The example project is renamed from examples/custom-atm-plugin to examples/custom-atm-extension, and its wheel/project metadata now uses bsk-extension-exponential-atmosphere.

This also prepares the SDK for the Basilisk 2.12 beta cycle by syncing the SDK version to 2.12.0b0, teaching CI to recognize PEP 440 alpha/beta versions such as 2.12.0a1 and 2.12.0b0, and making tools/sync_all.py update both src/bsk_sdk/_bsk_version.txt and the [project].version field in pyproject.toml.

Affected Surface

  • Packaging: pyproject.toml now reports 2.12.0b0
  • CMake/SWIG: comments and diagnostics now refer to extensions
  • Sync tooling: tools/sync_all.py stamps both SDK version files
  • Example extension: examples/custom-atm-extension
  • CI: beta/alpha SDK versions route to BSK develop and nightly wheels
  • Docs/tests: terminology and smoke assertions updated

Basilisk Version

Synced SDK version: 2.12.0b0

This branch is intended for the BSK 2.12 beta cycle. For aN / bN versions, CI tests against Basilisk develop and the nightly bsk[all] package set.

Downstream Compatibility

Existing BSK-SDK 2.10-2.11 users do not need to rename their projects. The public CMake helpers remain unchanged:

find_package(bsk-sdk CONFIG REQUIRED)
bsk_add_swig_module(...)
bsk_generate_messages(...)

Users will still need to rebuild extension wheels against the matching BSK/BSK-SDK 2.12 pair, but this naming change should not require source changes in existing plugin-named projects.

Verification

Local checks run:

.venv/bin/pytest tests/test_sync_all.py -v

Earlier local compatibility checks were also run for the renamed example extension:

.venv/bin/pytest tests/test_smoke.py -v
python -m build --wheel --no-isolation -o /private/tmp/bsk-extension-dist examples/custom-atm-extension
python -m pip install --force-reinstall --no-deps /private/tmp/bsk-extension-dist/bsk_extension_exponential_atmosphere-0.1.0-*.whl
.venv/bin/pytest examples/custom-atm-extension/customExponentialAtmosphere/_UnitTest/test_customExponentialAtmosphere.py -v

@schaubh schaubh self-assigned this Jul 10, 2026
@schaubh schaubh added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 10, 2026
@schaubh schaubh added this to Basilisk Jul 10, 2026
schaubh added 5 commits July 10, 2026 16:01
The BSK-SDK wheel products are really modular extensions of BSK.  We plan to use the name plugin for more flexible components down the road.
PEP 440 alpha/beta versions such as 2.12.0a1 and 2.12.0b0 should lead to beta-cycle PR CI testing against BSK develop and nightly wheels.
@schaubh schaubh force-pushed the feature/sdk_extension_naming branch from e3d2a88 to 35c2743 Compare July 10, 2026 22:02
@schaubh schaubh requested a review from ReeceHumphreys July 11, 2026 03:40

@ReeceHumphreys ReeceHumphreys left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks great, think this was the right direction!

@schaubh schaubh merged commit 0a70348 into develop Jul 12, 2026
18 checks passed
schaubh added a commit that referenced this pull request Jul 12, 2026
The BSK-SDK wheel products are really modular extensions of BSK.  We plan to use the name plugin for more flexible components down the road.
schaubh added a commit that referenced this pull request Jul 12, 2026
PEP 440 alpha/beta versions such as 2.12.0a1 and 2.12.0b0 should lead to beta-cycle PR CI testing against BSK develop and nightly wheels.
@schaubh schaubh deleted the feature/sdk_extension_naming branch July 12, 2026 19:19
@github-project-automation github-project-automation Bot moved this 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 enhancement New feature or request

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

2 participants