Skip to content

fix: remove confusing aws-export.js description #8325

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Apr 15, 2025
Merged

fix: remove confusing aws-export.js description #8325

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cbb3134
fix: remove confusing aws-export.js description
HuiSF Apr 14, 2025
e2d6706
Update src/pages/gen1/[platform]/tools/cli/reference/files/index.mdx
HuiSF Apr 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 2 additions & 12 deletions src/pages/gen1/[platform]/tools/cli/reference/files/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <category> 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, 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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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.
Note: You may also find a `aws-exports.js` file generated by Amplify CLI for JavaScript 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

Expand Down