From cbb31345541060469005d3588cfda49a5329318c Mon Sep 17 00:00:00 2001 From: Hui Zhao Date: Mon, 14 Apr 2025 14:18:11 -0700 Subject: [PATCH 1/2] fix: remove confusing aws-export.js description --- .../[platform]/tools/cli/reference/files/index.mdx | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/src/pages/gen1/[platform]/tools/cli/reference/files/index.mdx b/src/pages/gen1/[platform]/tools/cli/reference/files/index.mdx index e52427aa18a..956a600534f 100644 --- a/src/pages/gen1/[platform]/tools/cli/reference/files/index.mdx +++ b/src/pages/gen1/[platform]/tools/cli/reference/files/index.mdx @@ -117,25 +117,15 @@ Because one category might create multiple services within one project (e.g. the The metadata for each service is first logged into the meta file after the `amplify add` command is executed, containing some general information that indicates one service of the category has been added locally. Then, on the successful execution of the `amplify push` command, the `output` object will be added/updated in the service's metadata with information that describes the actual cloud resources that have been created or updated. -### aws-exports.js - -> Manual edits okay: NO - -> Add to version control: NO - -This file is generated only for JavaScript projects. It contains the consolidated outputs from all the categories and is placed under the `src` directory specified during the `init` process. It is updated after `amplify push`. - -This file is consumed by the [Amplify](https://github.com/aws-amplify/amplify-js) JavaScript library for configuration. It contains information which is non-sensitive and only required for external, unauthenticated actions from clients (such as user registration or sign-in flows in the case of Auth) or for constructing appropriate endpoint URLs after authorization has taken place. - ### amplifyconfiguration.json > Manual edits okay: NO > Add to version control: NO -This file is generated by Amplify CLI for Swift and Android projects. It contains the consolidated outputs from all the categories and is updated after `amplify push`. It is consumed by the [Amplify Swift](https://github.com/aws-amplify/amplify-swift/) and [Amplify Android](https://github.com/aws-amplify/amplify-android) libraries for configuration. +This file is generated by Amplify CLI for JavaScript or Typescript, Swift and Android projects. It contains the consolidated outputs from all the categories and is updated after `amplify push`. It is consumed by the [Amplify JS](https://github.com/aws-amplify/amplify-js), [Amplify Swift](https://github.com/aws-amplify/amplify-swift/) and [Amplify Android](https://github.com/aws-amplify/amplify-android) libraries for configuration. -Note: `amplifyconfiguration.json` is the equivalent of `aws-exports.js` generated for JavaScript projects. +Note: You may also find a `aws-exports.js` file generated by Amplify CLI for JavaScript or Typescript projects. This file is generated for backward compatibility. It is recommended to use `amplifyconfiguration.json`. Same as the `amplifyconfiguration.json` file, you should not manually edit this file, or add it to version control. ### .gitignore From e2d670694ca5b09c03b1832d339e723c83d5f13d Mon Sep 17 00:00:00 2001 From: Hui Zhao <10602282+HuiSF@users.noreply.github.com> Date: Mon, 14 Apr 2025 15:53:40 -0700 Subject: [PATCH 2/2] Update src/pages/gen1/[platform]/tools/cli/reference/files/index.mdx Co-authored-by: josef --- src/pages/gen1/[platform]/tools/cli/reference/files/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/gen1/[platform]/tools/cli/reference/files/index.mdx b/src/pages/gen1/[platform]/tools/cli/reference/files/index.mdx index 956a600534f..1dacb80f64f 100644 --- a/src/pages/gen1/[platform]/tools/cli/reference/files/index.mdx +++ b/src/pages/gen1/[platform]/tools/cli/reference/files/index.mdx @@ -123,7 +123,7 @@ The metadata for each service is first logged into the meta file after the `ampl > Add to version control: NO -This file is generated by Amplify CLI for JavaScript or Typescript, Swift and Android projects. It contains the consolidated outputs from all the categories and is updated after `amplify push`. It is consumed by the [Amplify JS](https://github.com/aws-amplify/amplify-js), [Amplify Swift](https://github.com/aws-amplify/amplify-swift/) and [Amplify Android](https://github.com/aws-amplify/amplify-android) libraries for configuration. +This file is generated by Amplify CLI for JavaScript, Swift and Android projects. It contains the consolidated outputs from all the categories and is updated after `amplify push`. It is consumed by the [Amplify JS](https://github.com/aws-amplify/amplify-js), [Amplify Swift](https://github.com/aws-amplify/amplify-swift/) and [Amplify Android](https://github.com/aws-amplify/amplify-android) libraries for configuration. Note: You may also find a `aws-exports.js` file generated by Amplify CLI for JavaScript or Typescript projects. This file is generated for backward compatibility. It is recommended to use `amplifyconfiguration.json`. Same as the `amplifyconfiguration.json` file, you should not manually edit this file, or add it to version control.