GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — WorkspaceBuilder: define a public builder protocol and entry points · Issue #1060 · tmux-python/tmuxp

WorkspaceBuilder: define a public builder protocol and entry points #1060

New issue
Copy link
New issue
Copy link
Closed
Closed
WorkspaceBuilder: define a public builder protocol and entry points#1060
Copy link
Labels
WorkspaceBuilderenhancement

Description

@tony
tony
opened on Jun 27, 2026
Issue body actions

Summary

Define the public contract for custom workspace builders after the classic dotted-path selection work lands.

Related: #1054, #1058.

Proposed behavior

  • Define a public builder protocol or interface that documents constructor inputs, .build(), .session, plugin lifecycle compatibility, append/detached behavior, progress callbacks, and script-output callbacks.
  • Keep sync builders supported first while making the interface shape compatible with future async builders.
  • Add package entry point discovery, for example a tmuxp.workspace_builders group, so packaged builders can be distributed without asking users to reference implementation module paths.
  • Keep dotted-path configuration from the base PR as the simple and transparent path for most users.
  • Document how tmuxp resolves builder names, dotted paths, and entry points without changing the classic default.

Acceptance criteria

  • The builder contract is represented in public code and docs.
  • Existing WorkspaceBuilder satisfies the contract.
  • Tests cover a minimal custom builder, an entry-point-discovered builder, and invalid builder failures.
  • The interface does not require async execution in this stage.

Activity

  1. tony
    added
    enhancement
    WorkspaceBuilder
    on Jun 27, 2026
  2. tony
    added a parent issue on Jun 27, 2026
    • Workspace builder roadmap: classic default, pluggable builders, readiness policy, and parallel loading #1058
  3. tony commented on Jun 29, 2026

    @tony
    tony
    on Jun 29, 2026
    MemberAuthor
    More actions

    Shipped in v1.73.0 (#1066). WorkspaceBuilderProtocol defines the builder contract (shaped to allow async builders later); builders register under the tmuxp.workspace_builders entry-point group, with the built-in ClassicWorkspaceBuilder registered as classic. WorkspaceBuilder remains importable as a backwards-compatible alias.

  4. tony
    closed this as completedon Jun 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    WorkspaceBuilderenhancement

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      You are visitor 01402503 — GeezerVison does not store the pages you look up.
      Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.