Skip to content

[Feature Request]: Support specifying output directory #218

@neilenns

Description

@neilenns

Preflight Checklist

  • I have searched the issue tracker for a feature request that matches the one I want to file, without success.

Problem Description

Currently, there's no way to specify the output folder for the files created by the plugin. It always goes to production.

This prevents the plugin from being usable with KiCad jobsets.

Proposed Solution

Add a --dest-dir parameter, or similar, so the output folder can be specified.

Alternatives Considered

I'm currently manually doing all the work via GitHub workflows, but this is the only part of my documentation/content generation that isn't handled via KiCad jobsets.

Additional Information

With this added it'll be possible to have KiCad handle running the plugin as part of a job, then zipping the results. Here's an example of how I'm doing it with a similar plugin, Interactive BOM:

Image

(Ignore the xvfb-run stuff, that's specific to the Interactive BOM running in a headless environment)

Notice I can specify the temporary output folder used by KiCad jobs ( --dest-dir "${JOBSET_OUTPUT_WORK_PATH}"), and when the job is complete KiCad will zip everything up into an archive I can then upload to my release in GitHub:

Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions