Skip to content

Default package installation to @stable instead of default branch #219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Copilot wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Default package installation to @stable instead of default branch #219

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6a8aa7d
Initial plan
Copilot Feb 1, 2026
d554d5e
Change default package version from dev-main to @stable
Copilot Feb 1, 2026
e197b85
Update get_github_latest_release_tag to fallback to default branch
Copilot Feb 1, 2026
2a4d65f
Refactor to eliminate code duplication in @stable resolution
Copilot Feb 3, 2026
be5aaa4
Add explicit JSON error check for better error handling
Copilot Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 40 additions & 18 deletions src/Package_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@
* | wp-cli/server-command | Daniel Bachhuber | dev-main | available | 2.x-dev |
* +-----------------------+------------------+----------+-----------+----------------+
*
* # Install the latest development version of the package.
* # Install the latest stable version of the package.
* $ wp package install wp-cli/server-command
* Installing package wp-cli/server-command (dev-main)
* Installing package wp-cli/server-command (^2.0)
* Updating /home/person/.wp-cli/packages/composer.json to require the package...
* Using Composer to install the package...
* ---
Expand Down Expand Up @@ -201,10 +201,10 @@ public function browse( $_, $assoc_args ) {
*
* ## EXAMPLES
*
* # Install a package hosted at a git URL.
* # Install the latest stable version of a package.
* $ wp package install runcommand/hook
*
* # Install the latest stable version.
* # Install the latest stable version (explicitly specified).
* $ wp package install wp-cli/server-command:@stable
*
* # Install a package hosted at a GitLab.com URL.
Expand All @@ -224,12 +224,16 @@ public function install( $args, $assoc_args ) {
$version = '';
if ( $this->is_git_repository( $package_name ) ) {
if ( '' === $version ) {
$version = "dev-{$this->get_github_default_branch( $package_name, $insecure )}";
$version = '@stable';
}
$git_package = $package_name;
$matches = [];
if ( preg_match( '#([^:\/]+\/[^\/]+)\.git#', $package_name, $matches ) ) {
$package_name = $this->check_git_package_name( $matches[1], $package_name, $version, $insecure );
$extracted_package_name = $matches[1];
if ( '@stable' === $version ) {
$version = $this->resolve_stable_version( $extracted_package_name, $insecure );
}
$package_name = $this->check_git_package_name( $extracted_package_name, $package_name, $version, $insecure );
} else {
WP_CLI::error( "Couldn't parse package name from expected path '<name>/<package>'." );
}
Expand Down Expand Up @@ -301,12 +305,11 @@ public function install( $args, $assoc_args ) {
$git_package = $package;

if ( '' === $version ) {
$version = "dev-{$this->get_github_default_branch( $package_name, $insecure )}";
$version = '@stable';
}

if ( '@stable' === $version ) {
$tag = $this->get_github_latest_release_tag( $package_name, $insecure );
$version = $this->guess_version_constraint_from_tag( $tag );
$version = $this->resolve_stable_version( $package_name, $insecure );
}
$package_name = $this->check_github_package_name( $package_name, $version, $insecure );
}
Expand Down Expand Up @@ -1349,26 +1352,45 @@ private function get_raw_git_version( $version ) {
return str_replace( [ '^', '~' ], '', $version );
}

/**
* Resolves '@stable' version to an actual version constraint.
*
* @param string $package_name Name of the repository.
* @param bool $insecure Whether to retry downloads without certificate validation if TLS handshake fails.
*
* @return string Version constraint.
*/
private function resolve_stable_version( $package_name, $insecure ) {
$tag = $this->get_github_latest_release_tag( $package_name, $insecure );
return $this->guess_version_constraint_from_tag( $tag );
}

/**
* Gets the release tag for the latest stable release of a GitHub repository.
*
* If there is no release, falls back to the default branch prefixed with 'dev-'.
*
* @param string $package_name Name of the repository.
* @param bool $insecure Whether to retry downloads without certificate validation if TLS handshake fails.
*
* @return string Release tag.
* @return string Release tag or 'dev-{default_branch}' if no release exists.
*/
private function get_github_latest_release_tag( $package_name, $insecure ) {
$url = "https://api.github.com/repos/{$package_name}/releases/latest";
$options = [ 'insecure' => $insecure ];
$response = Utils\http_request( 'GET', $url, null, [], $options );
if ( 20 !== (int) substr( $response->status_code, 0, 2 ) ) {
WP_CLI::warning( 'Could not guess stable version from GitHub repository, falling back to master branch' );
return 'master';
}

$package_data = json_decode( $response->body );
if ( JSON_ERROR_NONE !== json_last_error() ) {
WP_CLI::warning( 'Could not guess stable version from GitHub repository, falling back to master branch' );
return 'master';
// Check for successful response and valid JSON
$package_data = json_decode( $response->body ?? '' );

if ( 20 !== (int) substr( $response->status_code, 0, 2 )
|| JSON_ERROR_NONE !== json_last_error()
|| null === $package_data
|| ! isset( $package_data->tag_name ) ) {

$default_branch = $this->get_github_default_branch( $package_name, $insecure );
WP_CLI::warning( "Could not guess stable version from GitHub repository, falling back to {$default_branch} branch" );
return "dev-{$default_branch}";
}

$tag = $package_data->tag_name;
Expand Down