Skip to content

Commit f8be349

Browse files
authored
Merge pull request #197 from wp-cli/fix/update-readme-template
2 parents 4aa73c6 + f7f934e commit f8be349

File tree

3 files changed

+14
-3
lines changed

3 files changed

+14
-3
lines changed

src/ScaffoldPackageCommand.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,9 @@ public function package_readme( $args, $assoc_args ) {
252252
$readme_args['shields'] = implode( ' ', $composer_obj['extra']['readme']['shields'] );
253253
} else {
254254
$shields = [];
255+
if ( file_exists( $package_dir . '/.github/workflows/testing.yml' ) ) {
256+
$shields[] = "[![Testing](https://github.com/{$readme_args['package_name']}/actions/workflows/testing.yml/badge.svg)](https://github.com/{$readme_args['package_name']}/actions/workflows/testing.yml)";
257+
}
255258
if ( file_exists( $package_dir . '/.travis.yml' ) ) {
256259
$shields[] = "[![Build Status](https://travis-ci.org/{$readme_args['package_name']}.svg?branch=master)](https://travis-ci.org/{$readme_args['package_name']})";
257260
}

templates/readme-installing.mustache

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
Installing this package {{wp_cli_requires_instructions}}. Update to {{wp_cli_update_to_instructions}}.
22

3-
Once you've done so, you can install this package with:
3+
Once you've done so, you can install the latest stable version of this package with:
44

5-
wp package install git@github.com:{{package_name}}.git
5+
```bash
6+
wp package install {{package_name}}:@stable
7+
```
8+
9+
To install the latest development version of this package, use the following command instead:
10+
11+
```bash
12+
wp package install {{package_name}}:dev-master
13+
```

templates/readme-support.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Github issues aren't for general support questions, but there are other venues you can try: https://wp-cli.org/#support
1+
GitHub issues aren't for general support questions, but there are other venues you can try: https://wp-cli.org/#support

0 commit comments

Comments
 (0)