Skip to content

Commit

Permalink
Merge branch 'trunk' into update/docs-pt-vip-export
Browse files Browse the repository at this point in the history
  • Loading branch information
yolih committed Mar 27, 2024
2 parents dafaa72 + 71ad8d7 commit 16f3c8e
Show file tree
Hide file tree
Showing 11 changed files with 25 additions and 19 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ VIP-CLI is a tool for interacting with and managing your [WordPress VIP applicat

## Further information

- In the [WordPress VIP Lobby](https://lobby.vip.wordpress.com/) find announcements related to the [CLI](https://lobby.vip.wordpress.com/?s=vip-cli) and [API](https://lobby.vip.wordpress.com/?s=vip%20go%20api).
- The [WordPress VIP Documentation](https://docs.wpvip.com/) has instructions related to the [CLI](https://docs.wpvip.com/technical-references/vip-cli/).
- In the [WordPress VIP Lobby](https://lobby.vip.wordpress.com/) find announcements related to [VIP-CLI](https://lobby.vip.wordpress.com/?s=vip-cli) and [API](https://lobby.vip.wordpress.com/?s=vip%20go%20api).
- Find instructions for using [VIP-CLI](https://docs.wpvip.com/vip-cli/) in [WordPress VIP's Documentation](https://docs.wpvip.com/).
- [Changelog](https://github.com/Automattic/vip-cli/blob/trunk/docs/CHANGELOG.md) file for VIP-CLI is available.
- [VIP Cloud Changelog](https://wpvipchangelog.wordpress.com/) logs changes to the [CLI](https://wpvipchangelog.wordpress.com/?s=cli) and other aspects of the platform.
- [VIP Cloud Changelog](https://wpvipchangelog.wordpress.com/) logs changes to the [VIP-CLI](https://wpvipchangelog.wordpress.com/?s=cli) and other aspects of the platform.
2 changes: 1 addition & 1 deletion docs/ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Basic functionality

This is a CLI for interacting with and managing your [WordPress VIP applications](https://docs.wpvip.com/technical-references/vip-cli/). Data is inputted and outputted via terminal to the [API offered by WordPress VIP](#communicating-with-wpvip-api) and to/from local filesystem.
This is a CLI for interacting with and managing your [WordPress VIP applications](https://docs.wpvip.com/vip-cli/). Data is inputted and outputted via terminal to the [API offered by WordPress VIP](#communicating-with-wpvip-api) and to/from local filesystem.

For configuration, a few [environmental variables](SETUP.md#environmental-variables) are used and some [configuration files](SETUP.md#configuration-files) as well. No [database](#database) is required.

Expand Down
4 changes: 2 additions & 2 deletions docs/SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Then, launch the command and follow the prompts:
vip
```

If you need more information, check out our [VIP-CLI documentation](https://docs.wpvip.com/technical-references/vip-cli/).
If you need more information, check out our [VIP-CLI documentation](https://docs.wpvip.com/vip-cli/).

### Installation for developers

Expand Down Expand Up @@ -73,7 +73,7 @@ To start the software locally, run:
vip
```

If you need more information, check out our [VIP-CLI documentation](https://docs.wpvip.com/technical-references/vip-cli/).
If you need more information, check out our [VIP-CLI documentation](https://docs.wpvip.com/vip-cli/).

### Analytics

Expand Down
4 changes: 2 additions & 2 deletions npm-shrinkwrap.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@automattic/vip",
"version": "2.38.3-dev.0",
"version": "2.38.4-dev.0",
"description": "The VIP Javascript library & CLI",
"main": "index.js",
"bin": {
Expand Down
13 changes: 11 additions & 2 deletions src/bin/vip-import-sql.js
Original file line number Diff line number Diff line change
Expand Up @@ -231,13 +231,21 @@ const examples = [
},
];

export const promptToContinue = async ( { launched, formattedEnvironment, track, domain } ) => {
export const promptToContinue = async ( {
launched,
formattedEnvironment,
track,
domain,
tableNames,
} ) => {
console.log();
const promptToMatch = domain.toUpperCase();
const promptResponse = await prompt( {
type: 'input',
name: 'confirmedDomain',
message: `You are about to import the above tables into a ${
message: `You are about to import ${
tableNames && Array.isArray( tableNames ) && tableNames.length ? 'above tables' : ''
} into a ${
launched ? 'launched' : 'un-launched'
} ${ formattedEnvironment } site ${ chalk.yellow( domain ) }.\nType '${ chalk.yellow(
promptToMatch
Expand Down Expand Up @@ -459,6 +467,7 @@ void command( {
formattedEnvironment,
track,
domain,
tableNames,
} );

/**
Expand Down
4 changes: 1 addition & 3 deletions src/bin/vip-validate-preflight.js
Original file line number Diff line number Diff line change
Expand Up @@ -121,9 +121,7 @@ async function getBuildConfiguration( application, environment ) {
application.name
) } application.\n\n` +
'You can read more about organization and application roles on our documentation:\n' +
chalk.underline(
'https://docs.wpvip.com/technical-references/enterprise-authentication/'
)
chalk.underline( 'https://docs.wpvip.com/manage-user-access/vip-dashboard/' )
);

await trackEvent( 'validate_preflight_command_error', {
Expand Down
2 changes: 1 addition & 1 deletion src/commands/backup-db.ts
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ If you would like to run the same command, you can retry in ${ formatDuration(
Alternatively, you can export the latest existing database backup by running: ${ chalk.green(
'vip @app.env export sql'
) }, right away.
Learn more about limitations around generating database backups: https://docs.wpvip.com/technical-references/vip-dashboard/backups/#0-limitations
Learn more about limitations around generating database backups: https://docs.wpvip.com/databases/backups/limitations/
`;
exit.withError( errMessage );
}
Expand Down
2 changes: 1 addition & 1 deletion src/commands/export-sql.js
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ export class ExportSQLCommand {
noticeMessage +=
'If a recent database backup does not exist, a new one will be generated for this environment. ';
noticeMessage +=
'Learn more about this: https://docs.wpvip.com/technical-references/vip-dashboard/backups/#2-download-a-full-database-backup \n';
'Learn more about this: https://docs.wpvip.com/databases/backups/download-a-full-database-backup/ \n';
this.log( noticeMessage );

await cmd.run( false );
Expand Down
2 changes: 1 addition & 1 deletion src/lib/dev-environment/dev-environment-cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -533,7 +533,7 @@ function validateLocalPath( component: string, providedPath: string ) {
// eslint-disable-next-line max-len
const message = `Provided path "${ providedPath }" is missing following files/folders: ${ missingFiles.join(
', '
) }. Learn more: https://docs.wpvip.com/technical-references/vip-codebase/#1-wordpress`;
) }. Learn more: https://docs.wpvip.com/wordpress-skeleton/`;
return {
result: false,
message,
Expand Down
3 changes: 1 addition & 2 deletions src/lib/dev-environment/dev-environment-lando.ts
Original file line number Diff line number Diff line change
Expand Up @@ -413,8 +413,7 @@ export async function landoInfo(
}

// Add documentation link
appInfo.Documentation =
'https://docs.wpvip.com/technical-references/vip-local-development-environment/';
appInfo.Documentation = 'https://docs.wpvip.com/vip-local-development-environment/';

return appInfo as LandoInfoResult;
} finally {
Expand Down

0 comments on commit 16f3c8e

Please sign in to comment.