Skip to content

Conversation

@brianhogg
Copy link

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

Fixing install instructions for installing the latest dev version.
@brianhogg brianhogg requested a review from a team as a code owner May 2, 2024 14:10
@swissspidy
Copy link
Member

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
Copy link
Author

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
Copy link
Member

@brianhogg I gotcha covered! wp-cli/scaffold-package-command#241

@brianhogg brianhogg deleted the patch-1 branch May 4, 2024 07:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants