diff --git a/samcli/commands/pipeline/bootstrap/cli.py b/samcli/commands/pipeline/bootstrap/cli.py index c22300cefb..8d03a81dfe 100644 --- a/samcli/commands/pipeline/bootstrap/cli.py +++ b/samcli/commands/pipeline/bootstrap/cli.py @@ -18,7 +18,7 @@ SHORT_HELP = "Sets up infrastructure resources for AWS SAM CI/CD pipelines." HELP_TEXT = """Sets up the following infrastructure resources for AWS SAM CI/CD pipelines: -\n\t - Pipeline IAM user with access key ID and secret access key credentials to be shared with the CI/CD provider +\n\t - Pipeline IAM user with access key ID and secret access key credentials to be shared with the CI/CD system \n\t - Pipeline execution IAM role assumed by the pipeline user to obtain access to the AWS account \n\t - CloudFormation execution IAM role assumed by CloudFormation to deploy the AWS SAM application \n\t - Artifacts S3 bucket to hold the AWS SAM build artifacts @@ -44,7 +44,7 @@ ) @click.option( "--pipeline-user", - help="The ARN of the IAM user having its access key ID and secret access key shared with the CI/CD provider. " + help="The ARN of the IAM user having its access key ID and secret access key shared with the CI/CD system. " "It is used to grant this IAM user the permissions to access the corresponding AWS account. " "If not provided, the command will create one along with access key ID and secret access key credentials.", required=False, diff --git a/samcli/commands/pipeline/bootstrap/guided_context.py b/samcli/commands/pipeline/bootstrap/guided_context.py index c8d94cb9f6..4f5776162d 100644 --- a/samcli/commands/pipeline/bootstrap/guided_context.py +++ b/samcli/commands/pipeline/bootstrap/guided_context.py @@ -35,14 +35,17 @@ def run(self) -> None: and it will be created by the bootstrap command """ if not self.environment_name: - self.environment_name = click.prompt("Environment Name", type=click.STRING) + self.environment_name = click.prompt( + "Environment name (a descriptive name for the environment which will be deployed to this AWS account)", + type=click.STRING, + ) if not self.pipeline_user_arn: click.echo( "\nThere must be exactly one pipeline user across all of the environments. " "If you have ran this command before to bootstrap a previous environment, please " "provide the ARN of the created pipeline user, otherwise, we will create a new user for you. " - "Please make sure to store the credentials safely with the CI/CD provider." + "Please make sure to store the credentials safely with the CI/CD system." ) self.pipeline_user_arn = click.prompt( "Pipeline user [leave blank to create one]", default="", type=click.STRING diff --git a/samcli/commands/pipeline/init/cli.py b/samcli/commands/pipeline/init/cli.py index b90308bb7d..0a82f86dea 100644 --- a/samcli/commands/pipeline/init/cli.py +++ b/samcli/commands/pipeline/init/cli.py @@ -12,7 +12,7 @@ SHORT_HELP = "Generates CI/CD pipeline configuration files." HELP_TEXT = """ -Generates CI/CD pipeline configuration files for a chosen CI/CD provider such as Jenkins, +Generates CI/CD pipeline configuration files for a chosen CI/CD system such as Jenkins, GitLab CI/CD or GitHub Actions """ diff --git a/samcli/commands/pipeline/init/interactive_init_flow.py b/samcli/commands/pipeline/init/interactive_init_flow.py index 4679c6ca82..2efe5d6dc1 100644 --- a/samcli/commands/pipeline/init/interactive_init_flow.py +++ b/samcli/commands/pipeline/init/interactive_init_flow.py @@ -196,7 +196,7 @@ def _read_app_pipeline_templates_manifest(pipeline_templates_dir: Path) -> Pipel def _prompt_pipeline_template(pipeline_templates_manifest: PipelineTemplatesManifest) -> PipelineTemplateMetadata: """ - Prompts the user a list of the available CI/CD providers along with associated app pipeline templates to choose + Prompts the user a list of the available CI/CD systems along with associated app pipeline templates to choose one of them Parameters: @@ -217,10 +217,10 @@ def _prompt_pipeline_template(pipeline_templates_manifest: PipelineTemplatesMani def _prompt_cicd_provider(available_providers: List[Provider]) -> Provider: """ - Prompts the user a list of the available CI/CD providers to choose from + Prompts the user a list of the available CI/CD systems to choose from Parameters: - available_providers: List of available CI/CD providers such as Jenkins, Gitlab and CircleCI + available_providers: List of available CI/CD systems such as Jenkins, Gitlab and CircleCI Returns: The chosen provider @@ -230,7 +230,7 @@ def _prompt_cicd_provider(available_providers: List[Provider]) -> Provider: question_to_choose_provider = Choice( key="provider", - text="CI/CD provider", + text="CI/CD system", options=[p.display_name for p in available_providers], ) chosen_provider_display_name = question_to_choose_provider.ask() diff --git a/samcli/commands/pipeline/init/pipeline_templates_manifest.py b/samcli/commands/pipeline/init/pipeline_templates_manifest.py index 68d4fd2838..8249e14d85 100644 --- a/samcli/commands/pipeline/init/pipeline_templates_manifest.py +++ b/samcli/commands/pipeline/init/pipeline_templates_manifest.py @@ -29,7 +29,7 @@ class Provider: - """ CI/CD provider such as Jenkins, Gitlab and GitHub-Actions""" + """ CI/CD system such as Jenkins, Gitlab and GitHub-Actions""" def __init__(self, manifest: Dict) -> None: self.id: str = manifest["id"] @@ -46,7 +46,7 @@ def __init__(self, manifest: Dict) -> None: class PipelineTemplatesManifest: - """ The metadata of the available CI/CD providers and the pipeline templates""" + """ The metadata of the available CI/CD systems and the pipeline templates""" def __init__(self, manifest_path: Path) -> None: try: diff --git a/samcli/lib/pipeline/bootstrap/environment.py b/samcli/lib/pipeline/bootstrap/environment.py index 36cb318c77..e5f364dded 100644 --- a/samcli/lib/pipeline/bootstrap/environment.py +++ b/samcli/lib/pipeline/bootstrap/environment.py @@ -36,7 +36,7 @@ class Environment: aws_region: Optional[str] The AWS region to deploy this environment to. pipeline_user: IAMUser - The IAM User having its AccessKeyId and SecretAccessKey credentials shared with the CI/CD provider + The IAM User having its AccessKeyId and SecretAccessKey credentials shared with the CI/CD system pipeline_execution_role: Resource The IAM role assumed by the pipeline-user to get access to the AWS account and executes the CloudFormation stack. diff --git a/tests/unit/commands/pipeline/init/test_initeractive_init_flow.py b/tests/unit/commands/pipeline/init/test_initeractive_init_flow.py index 2f80694bf1..6bb0e5f89d 100644 --- a/tests/unit/commands/pipeline/init/test_initeractive_init_flow.py +++ b/tests/unit/commands/pipeline/init/test_initeractive_init_flow.py @@ -152,7 +152,7 @@ def test_generate_pipeline_configuration_file_from_app_pipeline_template_happy_c click_mock.prompt.side_effect = [ "1", # App pipeline templates - "2", # choose "Jenkins" when prompt for CI/CD provider. (See pipeline_templates_manifest_mock, Jenkins is the 2nd provider) + "2", # choose "Jenkins" when prompt for CI/CD system. (See pipeline_templates_manifest_mock, Jenkins is the 2nd provider) "1", # choose "Jenkins pipeline template" when prompt for pipeline template ] @@ -205,7 +205,7 @@ def test_generate_pipeline_configuration_file_when_pipeline_template_missing_que click_mock.prompt.side_effect = [ "1", # App pipeline templates - "2", # choose "Jenkins" when prompt for CI/CD provider. (See pipeline_templates_manifest_mock, Jenkins is the 2nd provider) + "2", # choose "Jenkins" when prompt for CI/CD system. (See pipeline_templates_manifest_mock, Jenkins is the 2nd provider) "1", # choose "Jenkins pipeline template" when prompt for pipeline template ]