Skip to content

Embed core/components in the xmd binary with a default component search path #83

Description

@taras

Motivation

The PR-review and repo-analysis workflows run on the released xmd binary but
still pass --component-dir core/components, pointing at the checked-out repo
(see .github/workflows/review.yml and .github/workflows/repo-analysis.yml).
core/components are framework provider components (AnthropicProvider.md,
Instruction.md, Sample.md, …) that should ship inside the binary, so a
consumer running the binary doesn't need the repo's core/components on disk.

Goal

Bundle core/components into the xmd binary and add a default component
search path
so --component-dir core/components is no longer required.

Notes / investigation

Unlike @executablemd/code-review-agent (a module resolved by import, bundled
via deno compile --include), core/components are .md files read from disk
by path at runtime. A compiled binary can't read them by their repo-relative
path, so this needs runtime component-resolution work:

  • Embed the .md components at compile time (--include core/components) and
    confirm they're readable at runtime from the compiled binary.
  • Add a default embedded component directory to the CLI's component resolution
    so bundled components are found without --component-dir.

Refs

Deferred from PR #82 (review runs on the released binary). Once done, drop the
--component-dir core/components flag from both workflows.

Activity

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

    No labels
    No labels

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions