My Workflow
AWS Amplify Pull-Request Previews currently only supports private GitHub repository. This amplify-preview-actions
GitHub action enables the ability to deploy AWS Amplify Pull-Request Previews for your open source and public GitHub repository.
With this amplify-preview-actions
GitHub action, you can define your own rule to deploy the Pull-Request branch to the AWS Amplify console app page for a preview. For example, you can setup a rule only a pull request is labeled with Ready for review
and is assigned to a reviewer; and clean up the previews after the pull request is merged or closed.
Submission Category:
DIY Deployments
Yaml File or Link to Code
GitHub Page
yinlinchen / amplify-preview-actions
This action deploys your AWS Amplify pull request preview for your public repository
amplify-preview-actions
AWS Amplify Pull-Request Previews currently only supports private GitHub repository. This amplify-preview-actions
GitHub action enables the ability to deploy AWS Amplify Pull-Request Previews for your open source and public GitHub repository.
With this amplify-preview-actions
GitHub action, you can define your own rule to deploy the Pull-Request branch to the AWS Amplify console app page for a preview. For example, you can setup a rule only a pull request is labeled with Ready for review
and is assigned to a reviewer; and clean up the previews after the pull request is merged or closed.
Getting Started
You can include the action in your workflow as actions/amplify-preview-actions@master
.
Basic workflow.yml
Example
Deploy a PR preview branch to the Amplify console App page (not the Previews page) after a reviewer is assigned.
Place in a .yml
file such as this one in your .github/workflows
folder. Refer to the documentation on workflow YAML…
GitHub Marketplace page
Installation
- name: amplify-preview-actions
uses: yinlinchen/amplify-preview-actions@v1.0
An example of how to use the Action:
name: 'Amplify PR Preview'
on:
pull_request:
types: [review_requested]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: set branchname env
id: setenvname
run: |
# use GITHUB_HEAD_REF that is set to PR source branch
echo "##[set-output name=setbranchname;]$(echo ${GITHUB_HEAD_REF})"
- name: deploy PR preview
uses: yinlinchen/amplify-preview-actions@master
with:
branch_name: ${{ steps.setenvname.outputs.setbranchname }}
amplify_command: deploy
env:
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
AmplifyAppId: ${{ secrets.AmplifyAppId }}
BackendEnvARN: ${{ secrets.BackendEnvARN }}
AWS_REGION: 'us-east-1'
Top comments (2)
I just tried it out, and works like a charm. You can add github.com/SimplQ/simplQ-frontend to your list if you want to :P
Thank you!! added.