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.

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

Conversation

HuiSF
Copy link
Member

@HuiSF HuiSF commented Apr 14, 2025

Description of changes:

Related GitHub issue #, if available:

#8239

Instructions

If this PR should not be merged upon approval for any reason, please submit as a DRAFT

Which product(s) are affected by this PR (if applicable)?

  • amplify-cli
  • amplify-ui
  • amplify-studio
  • amplify-hosting
  • amplify-libraries

Which platform(s) are affected by this PR (if applicable)?

  • JS
  • Swift
  • Android
  • Flutter
  • React Native

Please add the product(s)/platform(s) affected to the PR title

Checks

  • Does this PR conform to the styleguide?

  • Does this PR include filetypes other than markdown or images? Please add or update unit tests accordingly.

  • Are any files being deleted with this PR? If so, have the needed redirects been created?

  • Are all links in MDX files using the MDX link syntax rather than HTML link syntax?

    ref: MDX: [link](https://docs.amplify.aws/)
    HTML: <a href="https://docs.amplify.aws/">link</a>

When this PR is ready to merge, please check the box below

  • Ready to merge

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@HuiSF HuiSF requested a review from josefaidt as a code owner April 14, 2025 21:19
aadimch
aadimch previously approved these changes Apr 14, 2025
joon-won
joon-won previously approved these changes Apr 14, 2025
ashika112
ashika112 previously approved these changes Apr 14, 2025

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.

@HuiSF HuiSF dismissed stale reviews from ashika112, joon-won, and aadimch via e2d6706 April 14, 2025 22:53
@HuiSF HuiSF merged commit c6b6c99 into main Apr 15, 2025
12 checks passed
@HuiSF HuiSF deleted the hui/fix/aws-exports branch April 15, 2025 15:55
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.

Inconsistencies in docs concerning aws-exports.js and amplifyconfiguration.json
5 participants