WordPress / WordPress/php-toolkit

How to use files from plugin / blueprint repo in wp-cli blueprint step

Open
#99 13 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PHP
Stars
61
Forks
21
Avg merge
19h 34m
Merged PRs (30d)
7

Description

I'm currently looking to implement a preview for one of our wp.org hosted plugins. In order to set up a meaningful demo we'd like to import some sample data using a wp-cli command. It looks like I can specify a wp-cli step, but I'm unsure what the execution context is of that command and what files it can access.

Ideally I'd be looking at providing this sort of structure in the SVN repo:

  • assets
    • blueprints
      • blueprint.json
      • sample-replacements.csv

I tried referencing the file directly without any path information, as the example below, but that doesn't appear to work.

{
    "step": "wp-cli",
    "command": "wp say-what import sample-replacements.csv"
}

Is there a way to reference asset files in playground steps?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how the wp-cli step establishes its execution context and resolves files referenced by a blueprint. Compare that behavior with the proposed assets/blueprints/blueprint.json and sample-replacements.csv layout. Done means determining whether asset files can be referenced, or documenting the limitation and required supported behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
php, wordpress
Domain
cli, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.