Skip to content
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.

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

docs: rm description re: AWS CLI installations #314

Merged
merged 1 commit into from
Jan 18, 2024

Conversation

kelvintaywl
Copy link
Contributor

@kelvintaywl kelvintaywl commented Dec 18, 2023

Fixes the commands & jobs' descriptions re: AWS CLI installations.

As of v9.x, the commands & jobs do not explicitly install AWS CLI by default.
Rather, it is assumed that the executor chosen would have the AWS CLI already installed.
For instance, the aws-ecr/default executor is the ubuntu-2004:2022.04.2 Machine executor, which comes pre-installed with AWS CLI.

I understand that alternatively, users can ensure the AWS CLI is installed via:

  1. as part of the auth parameter's steps when using the build_and_push_image job, or
  2. adding AWS installation steps as pre-steps if needed

Checklist

  • All new jobs, commands, executors, parameters have descriptions
  • Examples have been added for any significant new features
  • README has been updated, if necessary

Motivation, issues

Description

As of v9.x, the commands & jobs does not explicitly install AWS CLI.
Rather, it is assumed that the executor chosen would have the AWS CLI already installed.
Alternatively, users can ensure the AWS CLI is installed as part of the `auth` parameter's steps
when using the build_and_push_image job.
@kelvintaywl kelvintaywl requested a review from a team as a code owner December 18, 2023 08:02
Copy link
Contributor

@brivu brivu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Solid work @kelvintaywl. Thanks for picking up the little details!!

@brivu brivu merged commit 441f120 into CircleCI-Public:master Jan 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants