chore: add callout about committing amplify config files for expo eas build #8274
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
HuiSF
force-pushed
the
hui/chore/expo-eas-bui
branch
from
064a379 to
11df997
Compare
HuiSF
changed the title
joon-won
previously approved these changes
Feb 28, 2025
HuiSF
force-pushed
the
hui/chore/expo-eas-bui
branch
from
11df997 to
7aa2ef2
Compare
josefaidt
reviewed
Feb 28, 2025
| <InlineFilter filters={['react-native']}> | ||
| <Callout> | ||
|
|
||
| **Note:** if you are using Expo EAS build, you will need to force commit the `amplify_outputs.json` file to local git repository before running `eas build` command. This is because the `amplify_outputs.json` file is not included in the default `.gitignore`, and the `eas build` command will not include untracked files in the build. |
There was a problem hiding this comment.
this will complicate git merges. Is there another way customers can set this up in EAS build? I'm not terribly familiar with it but it looks like folks can run arbitrary commands in the builds which would enable them to run the generate outputs command, assuming they have the ability to get credentials https://docs.expo.dev/eas/workflows/examples/#deploy-to-production-workflow
or environment variables?
There was a problem hiding this comment.
force commit ... to local git repository
or is this instructing folks to commit it locally, only?
There was a problem hiding this comment.
Yes that's correct, only need to add the config file into a local repo, before running the build command, this file itself doesn't need to be pushed to remote. This is a lowest requirement, developers can use various methods to perform this step before running eas build.
There was a problem hiding this comment.
Hmm, I'm concerned folks will inadvertently commit this file. could they instead use an .easignore file https://docs.expo.dev/build-reference/easignore/
or configure their build artifact paths in eas.json? https://docs.expo.dev/eas/json/#buildartifactpaths
if neither of those are applicable, can we expand on the callout to commit to a local repo/add some color around not pushing to the remote?
There was a problem hiding this comment.
From my research the lowest requirement for EAS is to ensure all files required for building the app in the version control. easignore is for ignoring files which is opposite to the requirement. buildartifactpaths is for post build steps I believe.
I will expand the callout.
ashika112
previously approved these changes
Mar 5, 2025
josefaidt
approved these changes
Mar 26, 2025
ashika112
approved these changes
Mar 31, 2025
ashika112
pushed a commit
that referenced
this pull request
Apr 10, 2025
… build (#8274) * chore: add callout about committing amplify config files for expo eas build * chore: expand the callout for not push amplify_outputs to remote repo
ashika112
added a commit
that referenced
this pull request
Apr 10, 2025
* chore: add decode cookie value strings note to SSR example (#8300) * chore: fix broken maplibre links (#8301) * chore: update secrets path ref (#8298) * chore: add callout about committing amplify config files for expo eas build (#8274) * chore: add callout about committing amplify config files for expo eas build * chore: expand the callout for not push amplify_outputs to remote repo * chore(deps): bump actions/upload-artifact from 4.6.0 to 4.6.2 (#8307) Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 4.6.0 to 4.6.2. - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](actions/upload-artifact@65c4c4a...ea165f8) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump actions/setup-node from 4.2.0 to 4.3.0 (#8306) Bumps [actions/setup-node](https://github.com/actions/setup-node) from 4.2.0 to 4.3.0. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](actions/setup-node@1d0ff46...cdca736) --- updated-dependencies: - dependency-name: actions/setup-node dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * feat: add retry strategy for api-rest category (#8295) * fix: Remove reference to using default with enum (#8311) * fix(storage): update instructions for adding external S3 buckets to Amplify (#8289) * fix(storage): update instructions for adding/integrating with external S3 buckets * rewrite examples, add user identity ID config, add examples for configuring storage without Amplify backend * address feedback, align some wording * reorder guest and auth'd user examples, update backend code examples to use CDK bucket construct * address feedback * update callout for adding existing bucket and amplify storage together, revert callout on owners example section * adjust headings, add heading before examples for better linking * chore: bump next version (#8313) * chore(deps): bump aws-actions/configure-aws-credentials (#8276) Bumps [aws-actions/configure-aws-credentials](https://github.com/aws-actions/configure-aws-credentials) from 4.0.3 to 4.1.0. - [Release notes](https://github.com/aws-actions/configure-aws-credentials/releases) - [Changelog](https://github.com/aws-actions/configure-aws-credentials/blob/main/CHANGELOG.md) - [Commits](aws-actions/configure-aws-credentials@4fc4975...ececac1) --- updated-dependencies: - dependency-name: aws-actions/configure-aws-credentials dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump aws-actions/aws-secretsmanager-get-secrets (#8278) Bumps [aws-actions/aws-secretsmanager-get-secrets](https://github.com/aws-actions/aws-secretsmanager-get-secrets) from 2.0.7 to 2.0.8. - [Release notes](https://github.com/aws-actions/aws-secretsmanager-get-secrets/releases) - [Commits](aws-actions/aws-secretsmanager-get-secrets@1d6311a...fbd65ea) --- updated-dependencies: - dependency-name: aws-actions/aws-secretsmanager-get-secrets dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * docs: update custom message with admincreateuser specifics (#8314) * chore: Update amplify-js API references * commit to trigger workflow * add pre-prod/main to workflows --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Hui Zhao <[email protected]> Co-authored-by: Tiffany Yeung <[email protected]> Co-authored-by: Jay Raval <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: aadimch <[email protected]> Co-authored-by: Aaron S. <[email protected]> Co-authored-by: James Jarvis <[email protected]> Co-authored-by: aws-amplify-bot <[email protected]> Co-authored-by: ashika112 <[email protected]>
ashika112
added a commit
that referenced
this pull request
Apr 10, 2025
* chore: amplify-js api references update (#8299) * chore(function): fix code snippet at set-up-function page (#8046) * Add `.authorization(allow => [allow.guest()])` * chore: Update amplify-js API references --------- Co-authored-by: Takahashi <[email protected]> Co-authored-by: aws-amplify-bot <[email protected]> * chore: amplify-js api references update (#8316) * chore: add decode cookie value strings note to SSR example (#8300) * chore: fix broken maplibre links (#8301) * chore: update secrets path ref (#8298) * chore: add callout about committing amplify config files for expo eas build (#8274) * chore: add callout about committing amplify config files for expo eas build * chore: expand the callout for not push amplify_outputs to remote repo * chore(deps): bump actions/upload-artifact from 4.6.0 to 4.6.2 (#8307) Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 4.6.0 to 4.6.2. - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](actions/upload-artifact@65c4c4a...ea165f8) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump actions/setup-node from 4.2.0 to 4.3.0 (#8306) Bumps [actions/setup-node](https://github.com/actions/setup-node) from 4.2.0 to 4.3.0. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](actions/setup-node@1d0ff46...cdca736) --- updated-dependencies: - dependency-name: actions/setup-node dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * feat: add retry strategy for api-rest category (#8295) * fix: Remove reference to using default with enum (#8311) * fix(storage): update instructions for adding external S3 buckets to Amplify (#8289) * fix(storage): update instructions for adding/integrating with external S3 buckets * rewrite examples, add user identity ID config, add examples for configuring storage without Amplify backend * address feedback, align some wording * reorder guest and auth'd user examples, update backend code examples to use CDK bucket construct * address feedback * update callout for adding existing bucket and amplify storage together, revert callout on owners example section * adjust headings, add heading before examples for better linking * chore: bump next version (#8313) * chore(deps): bump aws-actions/configure-aws-credentials (#8276) Bumps [aws-actions/configure-aws-credentials](https://github.com/aws-actions/configure-aws-credentials) from 4.0.3 to 4.1.0. - [Release notes](https://github.com/aws-actions/configure-aws-credentials/releases) - [Changelog](https://github.com/aws-actions/configure-aws-credentials/blob/main/CHANGELOG.md) - [Commits](aws-actions/configure-aws-credentials@4fc4975...ececac1) --- updated-dependencies: - dependency-name: aws-actions/configure-aws-credentials dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump aws-actions/aws-secretsmanager-get-secrets (#8278) Bumps [aws-actions/aws-secretsmanager-get-secrets](https://github.com/aws-actions/aws-secretsmanager-get-secrets) from 2.0.7 to 2.0.8. - [Release notes](https://github.com/aws-actions/aws-secretsmanager-get-secrets/releases) - [Commits](aws-actions/aws-secretsmanager-get-secrets@1d6311a...fbd65ea) --- updated-dependencies: - dependency-name: aws-actions/aws-secretsmanager-get-secrets dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * docs: update custom message with admincreateuser specifics (#8314) * chore: Update amplify-js API references * commit to trigger workflow * add pre-prod/main to workflows --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Hui Zhao <[email protected]> Co-authored-by: Tiffany Yeung <[email protected]> Co-authored-by: Jay Raval <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: aadimch <[email protected]> Co-authored-by: Aaron S. <[email protected]> Co-authored-by: James Jarvis <[email protected]> Co-authored-by: aws-amplify-bot <[email protected]> Co-authored-by: ashika112 <[email protected]> --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: aws-amplify-ops <[email protected]> Co-authored-by: Takahashi <[email protected]> Co-authored-by: aws-amplify-bot <[email protected]> Co-authored-by: Hui Zhao <[email protected]> Co-authored-by: Tiffany Yeung <[email protected]> Co-authored-by: Jay Raval <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: aadimch <[email protected]> Co-authored-by: Aaron S. <[email protected]> Co-authored-by: James Jarvis <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes:
Related GitHub issue #, if available:
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)?
Which platform(s) are affected by this PR (if applicable)?
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
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.