search

wp-cli / dist-archive-command

Create a distribution .zip or .tar.gz based on a plugin or theme's .distignore file
https://developer.wordpress.org/cli/commands/dist-archive/
MIT License
48 stars 24 forks source link

Update instructions for development version #94

Closed brianhogg closed 5 months ago

brianhogg commented 5 months ago

Fixing install instructions for installing the latest dev version (master vs main)

swissspidy commented 5 months ago

We'll have to fix this upstream in https://github.com/wp-cli/scaffold-package-command, which is the command used to automatically generate the readmes for all our commands.

https://github.com/wp-cli/scaffold-package-command/blob/b923d846aacd216554303b4583cc65eef3dd0cc5/templates/readme-installing.mustache#L12

The branch name is actually passed as an argument there:

https://github.com/wp-cli/scaffold-package-command/blob/b923d846aacd216554303b4583cc65eef3dd0cc5/src/ScaffoldPackageCommand.php#L251

So it should be possible to pass the branch name to the Mustache template.

If I'd just merge this PR, then the change would get reverted with the next automated readme update. That's why it must get addressed in the scaffold-package-command.

Is this something you'd be able to help address?

brianhogg commented 5 months ago

Understood! I'm not sure when I'll get to creating a more involved PR off that branch (either just renaming or else passing in a variable to the template).

I'll close this PR though.

danielbachhuber commented 5 months ago

@brianhogg I gotcha covered! https://github.com/wp-cli/scaffold-package-command/pull/241