Skip to content

Commit

Permalink
CLI-1342: [push:artifact] improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
danepowell committed Oct 23, 2024
1 parent 2d7f692 commit c9b9af6
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/Command/Push/PushArtifactCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ protected function configure(): void
->acceptEnvironmentId()
->setHelp('This command builds a sanitized deploy artifact by running <options=bold>composer install</>, removing sensitive files, and committing vendor directories.' . PHP_EOL . PHP_EOL

Check warning on line 58 in src/Command/Push/PushArtifactCommand.php

View workflow job for this annotation

GitHub Actions / Mutation Testing

Escaped Mutant for Mutator "ConcatOperandRemoval": --- Original +++ New @@ @@ protected Checklist $checklist; protected function configure() : void { - $this->addOption('dir', null, InputArgument::OPTIONAL, 'The directory containing the Drupal project to be pushed')->addOption('no-sanitize', null, InputOption::VALUE_NONE, 'Do not sanitize the build artifact')->addOption('dry-run', null, InputOption::VALUE_NONE, 'Deprecated: Use no-push instead')->addOption('no-push', null, InputOption::VALUE_NONE, 'Do not push changes to Acquia Cloud')->addOption('no-commit', null, InputOption::VALUE_NONE, 'Do not commit changes. Implies no-push')->addOption('no-clone', null, InputOption::VALUE_NONE, 'Do not clone repository. Implies no-commit and no-push')->addOption('destination-git-urls', 'u', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'The URL of your git repository to which the artifact branch will be pushed. Use multiple times for multiple URLs.')->addOption('destination-git-branch', 'b', InputOption::VALUE_REQUIRED, 'The destination branch to push the artifact to')->addOption('destination-git-tag', 't', InputOption::VALUE_REQUIRED, 'The destination tag to push the artifact to. Using this option requires also using the --destination-git-branch option')->addOption('source-git-tag', 's', InputOption::VALUE_REQUIRED, 'Deprecated: Use destination-git-branch instead')->acceptEnvironmentId()->setHelp('This command builds a sanitized deploy artifact by running <options=bold>composer install</>, removing sensitive files, and committing vendor directories.' . PHP_EOL . PHP_EOL . 'Vendor directories and scaffold files are committed to the build artifact even if they are ignored in the source repository.' . PHP_EOL . PHP_EOL . 'To run additional build or sanitization steps (e.g. <options=bold>npm install</>), add a <options=bold>post-install-cmd</> script to your <options=bold>composer.json</> file: https://getcomposer.org/doc/articles/scripts.md#command-events' . PHP_EOL . PHP_EOL . 'This command is designed for a specific scenario in which there are two branches or repositories involved: a source branch without vendor files committed, and an artifact branch with them. If both your source and destination branches are the same, you should simply use git push instead.')->addUsage('--destination-git-branch=main-build')->addUsage('--source-git-tag=foo-build --destination-git-tag=1.0.0')->addUsage('[email protected]:example.git [email protected]:example.git --destination-git-branch=main-build'); + $this->addOption('dir', null, InputArgument::OPTIONAL, 'The directory containing the Drupal project to be pushed')->addOption('no-sanitize', null, InputOption::VALUE_NONE, 'Do not sanitize the build artifact')->addOption('dry-run', null, InputOption::VALUE_NONE, 'Deprecated: Use no-push instead')->addOption('no-push', null, InputOption::VALUE_NONE, 'Do not push changes to Acquia Cloud')->addOption('no-commit', null, InputOption::VALUE_NONE, 'Do not commit changes. Implies no-push')->addOption('no-clone', null, InputOption::VALUE_NONE, 'Do not clone repository. Implies no-commit and no-push')->addOption('destination-git-urls', 'u', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'The URL of your git repository to which the artifact branch will be pushed. Use multiple times for multiple URLs.')->addOption('destination-git-branch', 'b', InputOption::VALUE_REQUIRED, 'The destination branch to push the artifact to')->addOption('destination-git-tag', 't', InputOption::VALUE_REQUIRED, 'The destination tag to push the artifact to. Using this option requires also using the --destination-git-branch option')->addOption('source-git-tag', 's', InputOption::VALUE_REQUIRED, 'Deprecated: Use destination-git-branch instead')->acceptEnvironmentId()->setHelp('This command builds a sanitized deploy artifact by running <options=bold>composer install</>, removing sensitive files, and committing vendor directories.' . PHP_EOL . PHP_EOL

Check warning on line 58 in src/Command/Push/PushArtifactCommand.php

View workflow job for this annotation

GitHub Actions / Mutation Testing

Escaped Mutant for Mutator "Concat": --- Original +++ New @@ @@ protected Checklist $checklist; protected function configure() : void { - $this->addOption('dir', null, InputArgument::OPTIONAL, 'The directory containing the Drupal project to be pushed')->addOption('no-sanitize', null, InputOption::VALUE_NONE, 'Do not sanitize the build artifact')->addOption('dry-run', null, InputOption::VALUE_NONE, 'Deprecated: Use no-push instead')->addOption('no-push', null, InputOption::VALUE_NONE, 'Do not push changes to Acquia Cloud')->addOption('no-commit', null, InputOption::VALUE_NONE, 'Do not commit changes. Implies no-push')->addOption('no-clone', null, InputOption::VALUE_NONE, 'Do not clone repository. Implies no-commit and no-push')->addOption('destination-git-urls', 'u', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'The URL of your git repository to which the artifact branch will be pushed. Use multiple times for multiple URLs.')->addOption('destination-git-branch', 'b', InputOption::VALUE_REQUIRED, 'The destination branch to push the artifact to')->addOption('destination-git-tag', 't', InputOption::VALUE_REQUIRED, 'The destination tag to push the artifact to. Using this option requires also using the --destination-git-branch option')->addOption('source-git-tag', 's', InputOption::VALUE_REQUIRED, 'Deprecated: Use destination-git-branch instead')->acceptEnvironmentId()->setHelp('This command builds a sanitized deploy artifact by running <options=bold>composer install</>, removing sensitive files, and committing vendor directories.' . PHP_EOL . PHP_EOL . 'Vendor directories and scaffold files are committed to the build artifact even if they are ignored in the source repository.' . PHP_EOL . PHP_EOL . 'To run additional build or sanitization steps (e.g. <options=bold>npm install</>), add a <options=bold>post-install-cmd</> script to your <options=bold>composer.json</> file: https://getcomposer.org/doc/articles/scripts.md#command-events' . PHP_EOL . PHP_EOL . 'This command is designed for a specific scenario in which there are two branches or repositories involved: a source branch without vendor files committed, and an artifact branch with them. If both your source and destination branches are the same, you should simply use git push instead.')->addUsage('--destination-git-branch=main-build')->addUsage('--source-git-tag=foo-build --destination-git-tag=1.0.0')->addUsage('[email protected]:example.git [email protected]:example.git --destination-git-branch=main-build'); + $this->addOption('dir', null, InputArgument::OPTIONAL, 'The directory containing the Drupal project to be pushed')->addOption('no-sanitize', null, InputOption::VALUE_NONE, 'Do not sanitize the build artifact')->addOption('dry-run', null, InputOption::VALUE_NONE, 'Deprecated: Use no-push instead')->addOption('no-push', null, InputOption::VALUE_NONE, 'Do not push changes to Acquia Cloud')->addOption('no-commit', null, InputOption::VALUE_NONE, 'Do not commit changes. Implies no-push')->addOption('no-clone', null, InputOption::VALUE_NONE, 'Do not clone repository. Implies no-commit and no-push')->addOption('destination-git-urls', 'u', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'The URL of your git repository to which the artifact branch will be pushed. Use multiple times for multiple URLs.')->addOption('destination-git-branch', 'b', InputOption::VALUE_REQUIRED, 'The destination branch to push the artifact to')->addOption('destination-git-tag', 't', InputOption::VALUE_REQUIRED, 'The destination tag to push the artifact to. Using this option requires also using the --destination-git-branch option')->addOption('source-git-tag', 's', InputOption::VALUE_REQUIRED, 'Deprecated: Use destination-git-branch instead')->acceptEnvironmentId()->setHelp('This command builds a sanitized deploy artifact by running <options=bold>composer install</>, removing sensitive files, and committing vendor directories.' . PHP_EOL . PHP_EOL . 'Vendor dir

Check warning on line 58 in src/Command/Push/PushArtifactCommand.php

View workflow job for this annotation

GitHub Actions / Mutation Testing

Escaped Mutant for Mutator "Concat": --- Original +++ New @@ @@ protected Checklist $checklist; protected function configure() : void { - $this->addOption('dir', null, InputArgument::OPTIONAL, 'The directory containing the Drupal project to be pushed')->addOption('no-sanitize', null, InputOption::VALUE_NONE, 'Do not sanitize the build artifact')->addOption('dry-run', null, InputOption::VALUE_NONE, 'Deprecated: Use no-push instead')->addOption('no-push', null, InputOption::VALUE_NONE, 'Do not push changes to Acquia Cloud')->addOption('no-commit', null, InputOption::VALUE_NONE, 'Do not commit changes. Implies no-push')->addOption('no-clone', null, InputOption::VALUE_NONE, 'Do not clone repository. Implies no-commit and no-push')->addOption('destination-git-urls', 'u', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'The URL of your git repository to which the artifact branch will be pushed. Use multiple times for multiple URLs.')->addOption('destination-git-branch', 'b', InputOption::VALUE_REQUIRED, 'The destination branch to push the artifact to')->addOption('destination-git-tag', 't', InputOption::VALUE_REQUIRED, 'The destination tag to push the artifact to. Using this option requires also using the --destination-git-branch option')->addOption('source-git-tag', 's', InputOption::VALUE_REQUIRED, 'Deprecated: Use destination-git-branch instead')->acceptEnvironmentId()->setHelp('This command builds a sanitized deploy artifact by running <options=bold>composer install</>, removing sensitive files, and committing vendor directories.' . PHP_EOL . PHP_EOL . 'Vendor directories and scaffold files are committed to the build artifact even if they are ignored in the source repository.' . PHP_EOL . PHP_EOL . 'To run additional build or sanitization steps (e.g. <options=bold>npm install</>), add a <options=bold>post-install-cmd</> script to your <options=bold>composer.json</> file: https://getcomposer.org/doc/articles/scripts.md#command-events' . PHP_EOL . PHP_EOL . 'This command is designed for a specific scenario in which there are two branches or repositories involved: a source branch without vendor files committed, and an artifact branch with them. If both your source and destination branches are the same, you should simply use git push instead.')->addUsage('--destination-git-branch=main-build')->addUsage('--source-git-tag=foo-build --destination-git-tag=1.0.0')->addUsage('[email protected]:example.git [email protected]:example.git --destination-git-branch=main-build'); + $this->addOption('dir', null, InputArgument::OPTIONAL, 'The directory containing the Drupal project to be pushed')->addOption('no-sanitize', null, InputOption::VALUE_NONE, 'Do not sanitize the build artifact')->addOption('dry-run', null, InputOption::VALUE_NONE, 'Deprecated: Use no-push instead')->addOption('no-push', null, InputOption::VALUE_NONE, 'Do not push changes to Acquia Cloud')->addOption('no-commit', null, InputOption::VALUE_NONE, 'Do not commit changes. Implies no-push')->addOption('no-clone', null, InputOption::VALUE_NONE, 'Do not clone repository. Implies no-commit and no-push')->addOption('destination-git-urls', 'u', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'The URL of your git repository to which the artifact branch will be pushed. Use multiple times for multiple URLs.')->addOption('destination-git-branch', 'b', InputOption::VALUE_REQUIRED, 'The destination branch to push the artifact to')->addOption('destination-git-tag', 't', InputOption::VALUE_REQUIRED, 'The destination tag to push the artifact to. Using this option requires also using the --destination-git-branch option')->addOption('source-git-tag', 's', InputOption::VALUE_REQUIRED, 'Deprecated: Use destination-git-branch instead')->acceptEnvironmentId()->setHelp('This command builds a sanitized deploy artifact by running <options=bold>composer install</>, removing sensitive files, and committing vendor directories.' . PHP_EOL . PHP_EOL . 'Vendor dir

Check warning on line 58 in src/Command/Push/PushArtifactCommand.php

View workflow job for this annotation

GitHub Actions / Mutation Testing

Escaped Mutant for Mutator "ConcatOperandRemoval": --- Original +++ New @@ @@ protected Checklist $checklist; protected function configure() : void { - $this->addOption('dir', null, InputArgument::OPTIONAL, 'The directory containing the Drupal project to be pushed')->addOption('no-sanitize', null, InputOption::VALUE_NONE, 'Do not sanitize the build artifact')->addOption('dry-run', null, InputOption::VALUE_NONE, 'Deprecated: Use no-push instead')->addOption('no-push', null, InputOption::VALUE_NONE, 'Do not push changes to Acquia Cloud')->addOption('no-commit', null, InputOption::VALUE_NONE, 'Do not commit changes. Implies no-push')->addOption('no-clone', null, InputOption::VALUE_NONE, 'Do not clone repository. Implies no-commit and no-push')->addOption('destination-git-urls', 'u', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'The URL of your git repository to which the artifact branch will be pushed. Use multiple times for multiple URLs.')->addOption('destination-git-branch', 'b', InputOption::VALUE_REQUIRED, 'The destination branch to push the artifact to')->addOption('destination-git-tag', 't', InputOption::VALUE_REQUIRED, 'The destination tag to push the artifact to. Using this option requires also using the --destination-git-branch option')->addOption('source-git-tag', 's', InputOption::VALUE_REQUIRED, 'Deprecated: Use destination-git-branch instead')->acceptEnvironmentId()->setHelp('This command builds a sanitized deploy artifact by running <options=bold>composer install</>, removing sensitive files, and committing vendor directories.' . PHP_EOL . PHP_EOL . 'Vendor directories and scaffold files are committed to the build artifact even if they are ignored in the source repository.' . PHP_EOL . PHP_EOL . 'To run additional build or sanitization steps (e.g. <options=bold>npm install</>), add a <options=bold>post-install-cmd</> script to your <options=bold>composer.json</> file: https://getcomposer.org/doc/articles/scripts.md#command-events' . PHP_EOL . PHP_EOL . 'This command is designed for a specific scenario in which there are two branches or repositories involved: a source branch without vendor files committed, and an artifact branch with them. If both your source and destination branches are the same, you should simply use git push instead.')->addUsage('--destination-git-branch=main-build')->addUsage('--source-git-tag=foo-build --destination-git-tag=1.0.0')->addUsage('[email protected]:example.git [email protected]:example.git --destination-git-branch=main-build'); + $this->addOption('dir', null, InputArgument::OPTIONAL, 'The directory containing the Drupal project to be pushed')->addOption('no-sanitize', null, InputOption::VALUE_NONE, 'Do not sanitize the build artifact')->addOption('dry-run', null, InputOption::VALUE_NONE, 'Deprecated: Use no-push instead')->addOption('no-push', null, InputOption::VALUE_NONE, 'Do not push changes to Acquia Cloud')->addOption('no-commit', null, InputOption::VALUE_NONE, 'Do not commit changes. Implies no-push')->addOption('no-clone', null, InputOption::VALUE_NONE, 'Do not clone repository. Implies no-commit and no-push')->addOption('destination-git-urls', 'u', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'The URL of your git repository to which the artifact branch will be pushed. Use multiple times for multiple URLs.')->addOption('destination-git-branch', 'b', InputOption::VALUE_REQUIRED, 'The destination branch to push the artifact to')->addOption('destination-git-tag', 't', InputOption::VALUE_REQUIRED, 'The destination tag to push the artifact to. Using this option requires also using the --destination-git-branch option')->addOption('source-git-tag', 's', InputOption::VALUE_REQUIRED, 'Deprecated: Use destination-git-branch instead')->acceptEnvironmentId()->setHelp('This command builds a sanitized deploy artifact by running <options=bold>composer install</>, removing sensitive files, and committing vendor directories.' . PHP_EOL . PHP_EOL

Check warning on line 58 in src/Command/Push/PushArtifactCommand.php

View workflow job for this annotation

GitHub Actions / Mutation Testing

Escaped Mutant for Mutator "Concat": --- Original +++ New @@ @@ protected Checklist $checklist; protected function configure() : void { - $this->addOption('dir', null, InputArgument::OPTIONAL, 'The directory containing the Drupal project to be pushed')->addOption('no-sanitize', null, InputOption::VALUE_NONE, 'Do not sanitize the build artifact')->addOption('dry-run', null, InputOption::VALUE_NONE, 'Deprecated: Use no-push instead')->addOption('no-push', null, InputOption::VALUE_NONE, 'Do not push changes to Acquia Cloud')->addOption('no-commit', null, InputOption::VALUE_NONE, 'Do not commit changes. Implies no-push')->addOption('no-clone', null, InputOption::VALUE_NONE, 'Do not clone repository. Implies no-commit and no-push')->addOption('destination-git-urls', 'u', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'The URL of your git repository to which the artifact branch will be pushed. Use multiple times for multiple URLs.')->addOption('destination-git-branch', 'b', InputOption::VALUE_REQUIRED, 'The destination branch to push the artifact to')->addOption('destination-git-tag', 't', InputOption::VALUE_REQUIRED, 'The destination tag to push the artifact to. Using this option requires also using the --destination-git-branch option')->addOption('source-git-tag', 's', InputOption::VALUE_REQUIRED, 'Deprecated: Use destination-git-branch instead')->acceptEnvironmentId()->setHelp('This command builds a sanitized deploy artifact by running <options=bold>composer install</>, removing sensitive files, and committing vendor directories.' . PHP_EOL . PHP_EOL . 'Vendor directories and scaffold files are committed to the build artifact even if they are ignored in the source repository.' . PHP_EOL . PHP_EOL . 'To run additional build or sanitization steps (e.g. <options=bold>npm install</>), add a <options=bold>post-install-cmd</> script to your <options=bold>composer.json</> file: https://getcomposer.org/doc/articles/scripts.md#command-events' . PHP_EOL . PHP_EOL . 'This command is designed for a specific scenario in which there are two branches or repositories involved: a source branch without vendor files committed, and an artifact branch with them. If both your source and destination branches are the same, you should simply use git push instead.')->addUsage('--destination-git-branch=main-build')->addUsage('--source-git-tag=foo-build --destination-git-tag=1.0.0')->addUsage('[email protected]:example.git [email protected]:example.git --destination-git-branch=main-build'); + $this->addOption('dir', null, InputArgument::OPTIONAL, 'The directory containing the Drupal project to be pushed')->addOption('no-sanitize', null, InputOption::VALUE_NONE, 'Do not sanitize the build artifact')->addOption('dry-run', null, InputOption::VALUE_NONE, 'Deprecated: Use no-push instead')->addOption('no-push', null, InputOption::VALUE_NONE, 'Do not push changes to Acquia Cloud')->addOption('no-commit', null, InputOption::VALUE_NONE, 'Do not commit changes. Implies no-push')->addOption('no-clone', null, InputOption::VALUE_NONE, 'Do not clone repository. Implies no-commit and no-push')->addOption('destination-git-urls', 'u', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'The URL of your git repository to which the artifact branch will be pushed. Use multiple times for multiple URLs.')->addOption('destination-git-branch', 'b', InputOption::VALUE_REQUIRED, 'The destination branch to push the artifact to')->addOption('destination-git-tag', 't', InputOption::VALUE_REQUIRED, 'The destination tag to push the artifact to. Using this option requires also using the --destination-git-branch option')->addOption('source-git-tag', 's', InputOption::VALUE_REQUIRED, 'Deprecated: Use destination-git-branch instead')->acceptEnvironmentId()->setHelp('This command builds a sanitized deploy artifact by running <options=bold>composer install</>, removing sensitive files, and committing vendor directories.' . PHP_EOL . PHP_EOL . 'Vendor dir

Check warning on line 58 in src/Command/Push/PushArtifactCommand.php

View workflow job for this annotation

GitHub Actions / Mutation Testing

Escaped Mutant for Mutator "ConcatOperandRemoval": --- Original +++ New @@ @@ protected Checklist $checklist; protected function configure() : void { - $this->addOption('dir', null, InputArgument::OPTIONAL, 'The directory containing the Drupal project to be pushed')->addOption('no-sanitize', null, InputOption::VALUE_NONE, 'Do not sanitize the build artifact')->addOption('dry-run', null, InputOption::VALUE_NONE, 'Deprecated: Use no-push instead')->addOption('no-push', null, InputOption::VALUE_NONE, 'Do not push changes to Acquia Cloud')->addOption('no-commit', null, InputOption::VALUE_NONE, 'Do not commit changes. Implies no-push')->addOption('no-clone', null, InputOption::VALUE_NONE, 'Do not clone repository. Implies no-commit and no-push')->addOption('destination-git-urls', 'u', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'The URL of your git repository to which the artifact branch will be pushed. Use multiple times for multiple URLs.')->addOption('destination-git-branch', 'b', InputOption::VALUE_REQUIRED, 'The destination branch to push the artifact to')->addOption('destination-git-tag', 't', InputOption::VALUE_REQUIRED, 'The destination tag to push the artifact to. Using this option requires also using the --destination-git-branch option')->addOption('source-git-tag', 's', InputOption::VALUE_REQUIRED, 'Deprecated: Use destination-git-branch instead')->acceptEnvironmentId()->setHelp('This command builds a sanitized deploy artifact by running <options=bold>composer install</>, removing sensitive files, and committing vendor directories.' . PHP_EOL . PHP_EOL . 'Vendor directories and scaffold files are committed to the build artifact even if they are ignored in the source repository.' . PHP_EOL . PHP_EOL . 'To run additional build or sanitization steps (e.g. <options=bold>npm install</>), add a <options=bold>post-install-cmd</> script to your <options=bold>composer.json</> file: https://getcomposer.org/doc/articles/scripts.md#command-events' . PHP_EOL . PHP_EOL . 'This command is designed for a specific scenario in which there are two branches or repositories involved: a source branch without vendor files committed, and an artifact branch with them. If both your source and destination branches are the same, you should simply use git push instead.')->addUsage('--destination-git-branch=main-build')->addUsage('--source-git-tag=foo-build --destination-git-tag=1.0.0')->addUsage('[email protected]:example.git [email protected]:example.git --destination-git-branch=main-build'); + $this->addOption('dir', null, InputArgument::OPTIONAL, 'The directory containing the Drupal project to be pushed')->addOption('no-sanitize', null, InputOption::VALUE_NONE, 'Do not sanitize the build artifact')->addOption('dry-run', null, InputOption::VALUE_NONE, 'Deprecated: Use no-push instead')->addOption('no-push', null, InputOption::VALUE_NONE, 'Do not push changes to Acquia Cloud')->addOption('no-commit', null, InputOption::VALUE_NONE, 'Do not commit changes. Implies no-push')->addOption('no-clone', null, InputOption::VALUE_NONE, 'Do not clone repository. Implies no-commit and no-push')->addOption('destination-git-urls', 'u', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'The URL of your git repository to which the artifact branch will be pushed. Use multiple times for multiple URLs.')->addOption('destination-git-branch', 'b', InputOption::VALUE_REQUIRED, 'The destination branch to push the artifact to')->addOption('destination-git-tag', 't', InputOption::VALUE_REQUIRED, 'The destination tag to push the artifact to. Using this option requires also using the --destination-git-branch option')->addOption('source-git-tag', 's', InputOption::VALUE_REQUIRED, 'Deprecated: Use destination-git-branch instead')->acceptEnvironmentId()->setHelp('This command builds a sanitized deploy artifact by running <options=bold>composer install</>, removing sensitive files, and committing vendor directories.' . PHP_EOL . PHP_EOL

Check warning on line 58 in src/Command/Push/PushArtifactCommand.php

View workflow job for this annotation

GitHub Actions / Mutation Testing

Escaped Mutant for Mutator "ConcatOperandRemoval": --- Original +++ New @@ @@ protected Checklist $checklist; protected function configure() : void { - $this->addOption('dir', null, InputArgument::OPTIONAL, 'The directory containing the Drupal project to be pushed')->addOption('no-sanitize', null, InputOption::VALUE_NONE, 'Do not sanitize the build artifact')->addOption('dry-run', null, InputOption::VALUE_NONE, 'Deprecated: Use no-push instead')->addOption('no-push', null, InputOption::VALUE_NONE, 'Do not push changes to Acquia Cloud')->addOption('no-commit', null, InputOption::VALUE_NONE, 'Do not commit changes. Implies no-push')->addOption('no-clone', null, InputOption::VALUE_NONE, 'Do not clone repository. Implies no-commit and no-push')->addOption('destination-git-urls', 'u', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'The URL of your git repository to which the artifact branch will be pushed. Use multiple times for multiple URLs.')->addOption('destination-git-branch', 'b', InputOption::VALUE_REQUIRED, 'The destination branch to push the artifact to')->addOption('destination-git-tag', 't', InputOption::VALUE_REQUIRED, 'The destination tag to push the artifact to. Using this option requires also using the --destination-git-branch option')->addOption('source-git-tag', 's', InputOption::VALUE_REQUIRED, 'Deprecated: Use destination-git-branch instead')->acceptEnvironmentId()->setHelp('This command builds a sanitized deploy artifact by running <options=bold>composer install</>, removing sensitive files, and committing vendor directories.' . PHP_EOL . PHP_EOL . 'Vendor directories and scaffold files are committed to the build artifact even if they are ignored in the source repository.' . PHP_EOL . PHP_EOL . 'To run additional build or sanitization steps (e.g. <options=bold>npm install</>), add a <options=bold>post-install-cmd</> script to your <options=bold>composer.json</> file: https://getcomposer.org/doc/articles/scripts.md#command-events' . PHP_EOL . PHP_EOL . 'This command is designed for a specific scenario in which there are two branches or repositories involved: a source branch without vendor files committed, and an artifact branch with them. If both your source and destination branches are the same, you should simply use git push instead.')->addUsage('--destination-git-branch=main-build')->addUsage('--source-git-tag=foo-build --destination-git-tag=1.0.0')->addUsage('[email protected]:example.git [email protected]:example.git --destination-git-branch=main-build'); + $this->addOption('dir', null, InputArgument::OPTIONAL, 'The directory containing the Drupal project to be pushed')->addOption('no-sanitize', null, InputOption::VALUE_NONE, 'Do not sanitize the build artifact')->addOption('dry-run', null, InputOption::VALUE_NONE, 'Deprecated: Use no-push instead')->addOption('no-push', null, InputOption::VALUE_NONE, 'Do not push changes to Acquia Cloud')->addOption('no-commit', null, InputOption::VALUE_NONE, 'Do not commit changes. Implies no-push')->addOption('no-clone', null, InputOption::VALUE_NONE, 'Do not clone repository. Implies no-commit and no-push')->addOption('destination-git-urls', 'u', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'The URL of your git repository to which the artifact branch will be pushed. Use multiple times for multiple URLs.')->addOption('destination-git-branch', 'b', InputOption::VALUE_REQUIRED, 'The destination branch to push the artifact to')->addOption('destination-git-tag', 't', InputOption::VALUE_REQUIRED, 'The destination tag to push the artifact to. Using this option requires also using the --destination-git-branch option')->addOption('source-git-tag', 's', InputOption::VALUE_REQUIRED, 'Deprecated: Use destination-git-branch instead')->acceptEnvironmentId()->setHelp('This command builds a sanitized deploy artifact by running <options=bold>composer install</>, removing sensitive files, and committing vendor directories.' . PHP_EOL . PHP_EOL
. 'Vendor directories and scaffold files are committed to the build artifact even if they are ignored in the source repository.' . PHP_EOL . PHP_EOL
. 'To run additional build or sanitization steps (e.g. <options=bold>npm install</>), add a <options=bold>post-install-cmd</> script to your <options=bold>composer.json</> file: https://getcomposer.org/doc/articles/scripts.md#command-events')
. 'To run additional build or sanitization steps (e.g. <options=bold>npm install</>), add a <options=bold>post-install-cmd</> script to your <options=bold>composer.json</> file: https://getcomposer.org/doc/articles/scripts.md#command-events' . PHP_EOL . PHP_EOL
. 'This command is designed for a specific scenario in which there are two branches or repositories involved: a source branch without vendor files committed, and an artifact branch with them. If both your source and destination branches are the same, you should simply use git push instead.')
->addUsage('--destination-git-branch=main-build')
->addUsage('--source-git-tag=foo-build --destination-git-tag=1.0.0')
->addUsage('[email protected]:example.git [email protected]:example.git --destination-git-branch=main-build');
Expand Down

0 comments on commit c9b9af6

Please sign in to comment.