|
| 1 | +# amplify-preview |
| 2 | + |
| 3 | + |
| 4 | +This gha-tool is basically re-implements what [AWS Amplify's GitHub integration should be doing](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html), |
| 5 | +however because of following limitations, we can't really use it for some of the repos: |
| 6 | +- [No way to filter for which PRs to generate preview deployments](https://github.com/aws-amplify/amplify-hosting/issues/3960) |
| 7 | +- [Hard limit of 50 preview branches per amplify app][https://docs.aws.amazon.com/amplify/latest/userguide/quotas-chapter.html] |
| 8 | +- [No way to create PR preview programmatically](https://github.com/aws-amplify/amplify-hosting/issues/3963) |
| 9 | + |
| 10 | +This action accepts of AWS Amplify App IDs, checks if current git branch is connected to the apps and posts deployment status and PR preview in PR comments. |
| 11 | + |
| 12 | +If `--create-branches` is enabled, then it will also connect git branch to one of the AWS Amplify apps (where hard limit of 50 branches hasn't been reached yet) and kick of new build. |
| 13 | +If `--wait` is enabled, then it will also wait for deployment to be completed and fail the GHA run if deployment had failed. |
| 14 | + |
| 15 | +## Usage |
| 16 | + |
| 17 | +```shell |
| 18 | +usage: amplify-preview --amplify-app-ids=AMPLIFY-APP-IDS --git-branch-name=GIT-BRANCH-NAME [<flags>] |
| 19 | + |
| 20 | +Flags: |
| 21 | + --[no-]help Show context-sensitive help (also try --help-long and --help-man). |
| 22 | + --amplify-app-ids=AMPLIFY-APP-IDS ... |
| 23 | + List of Amplify App IDs ($AMPLIFY_APP_IDS) |
| 24 | + --git-branch-name=GIT-BRANCH-NAME |
| 25 | + Git branch name ($GIT_BRANCH_NAME) |
| 26 | + --[no-]create-branches Defines whether Amplify branches should be created if missing, or just lookup existing ones ($CREATE_BRANCHES) |
| 27 | + --[no-]wait Wait for pending/running job to complete ($WAIT) |
| 28 | +``` |
| 29 | +
|
| 30 | +Example GHA workflow: |
| 31 | +
|
| 32 | +```yaml |
| 33 | +name: Amplify Preview |
| 34 | +on: |
| 35 | + pull_request: |
| 36 | + paths: |
| 37 | + - 'docs/**' |
| 38 | + workflow_dispatch: |
| 39 | + |
| 40 | +permissions: |
| 41 | + # Permissions to write PR comment |
| 42 | + pull-requests: write |
| 43 | + id-token: write |
| 44 | + |
| 45 | +jobs: |
| 46 | + amplify-preview: |
| 47 | + name: Get and post Amplify preview URL |
| 48 | + runs-on: ubuntu-22.04-2core-arm64 |
| 49 | + environment: docs-amplify |
| 50 | + steps: |
| 51 | + - name: Checkout shared-workflow |
| 52 | + uses: actions/checkout@v4 |
| 53 | + with: |
| 54 | + repository: gravitational/shared-workflows |
| 55 | + sparse-checkout: | |
| 56 | + tools |
| 57 | + |
| 58 | + - name: Configure AWS credentials |
| 59 | + uses: aws-actions/configure-aws-credentials@e3dd6a429d7300a6a4c196c26e071d42e0343502 # v4 |
| 60 | + with: |
| 61 | + aws-region: us-west-2 |
| 62 | + role-to-assume: ${{ vars.IAM_ROLE }} |
| 63 | + |
| 64 | + - name: Check Amplify job status test |
| 65 | + uses: ./tools/amplify-preview |
| 66 | + with: |
| 67 | + app_ids: ${{ vars.AMPLIFY_APP_IDS }} |
| 68 | + create_branches: "true" |
| 69 | + github_token: ${{ secrets.GITHUB_TOKEN }} |
| 70 | + wait: "true" |
| 71 | +``` |
| 72 | +
|
| 73 | +## AWS Permissions |
| 74 | +
|
| 75 | +For this action to work, AWS role with following IAM permissions is required: |
| 76 | +```json |
| 77 | +{ |
| 78 | + "Statement": [ |
| 79 | + { |
| 80 | + "Action": [ |
| 81 | + "amplify:CreateBranch", |
| 82 | + "amplify:GetBranch", |
| 83 | + "amplify:ListJobs" |
| 84 | + "amplify:StartJob", |
| 85 | + ], |
| 86 | + "Effect": "Allow", |
| 87 | + "Resource": [ |
| 88 | + "arn:aws:amplify:<region>:<account_id>:apps/<app_id>/branches/*" |
| 89 | + ] |
| 90 | + } |
| 91 | + ], |
| 92 | + "Version": "2012-10-17" |
| 93 | +} |
| 94 | +``` |
| 95 | +
|
| 96 | +Where `amplify:CreateBranch` and `amplify:StartJob` are needed only when `--create-branches` is enabled. |
0 commit comments