-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
amplify-preview: custom action to trigger amplify previews (#287)
* Initial version of `amplify-preview` action * Add readme * Dependency fixes * Add CICD files * Address PR feedback * PR feedback, part 2
- Loading branch information
Showing
16 changed files
with
2,478 additions
and
6 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| --- | ||
| name: Amplify Preview CD | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - tools/amplify-preview | ||
| tags: | ||
| - "tools/amplify-preview/v[0-9]+.[0-9]+.[0-9]+**" | ||
| pull_request: | ||
| paths: | ||
| - tools/amplify-preview/workflows/cd.yaml | ||
| - .github/workflows/amplify-preview-cd.yaml | ||
| - .github/workflows/reusable-cd.yaml | ||
|
|
||
| jobs: | ||
| release: | ||
| uses: ./.github/workflows/reusable-cd.yaml | ||
| permissions: | ||
| contents: write | ||
| packages: write | ||
| with: | ||
| tool-directory: ./tools/amplify-preview |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| --- | ||
| name: Amplify Preview CI | ||
|
|
||
| on: | ||
| pull_request: | ||
|
|
||
| jobs: | ||
| release: | ||
| uses: ./.github/workflows/reusable-ci.yaml | ||
| permissions: | ||
| contents: write | ||
| packages: write | ||
| with: | ||
| tool-directory: ./tools/amplify-preview |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| package github | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "strings" | ||
|
|
||
| "github.com/google/go-github/v63/github" | ||
| ) | ||
|
|
||
| var ( | ||
| ErrCommentNotFound = errors.New("comment not found") | ||
| ) | ||
|
|
||
| // IssueIdentifier represents an issue or PR on GitHub | ||
| type IssueIdentifier struct { | ||
| Owner string | ||
| Repo string | ||
| Number int | ||
| } | ||
|
|
||
| // CommentTraits defines optional traits to filter comments. | ||
| // Every trait (if non-empty-string) is matched with an "AND" operator | ||
| type CommentTraits struct { | ||
| BodyContains string | ||
| UserLogin string | ||
| } | ||
|
|
||
| // FindCommentByTraits searches for a comment in an PR or issue based on specified traits | ||
| func (c *Client) FindCommentByTraits(ctx context.Context, issue IssueIdentifier, targetComment CommentTraits) (*github.IssueComment, error) { | ||
| comments, _, err := c.client.Issues.ListComments(ctx, issue.Owner, issue.Repo, issue.Number, nil) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| for _, c := range comments { | ||
| matcher := true | ||
| if targetComment.UserLogin != "" { | ||
| matcher = matcher && c.User.GetLogin() == targetComment.UserLogin | ||
| } | ||
|
|
||
| if targetComment.BodyContains != "" { | ||
| matcher = matcher && strings.Contains(c.GetBody(), targetComment.BodyContains) | ||
| } | ||
|
|
||
| if matcher { | ||
| return c, nil | ||
| } | ||
| } | ||
|
|
||
| return nil, ErrCommentNotFound | ||
| } | ||
|
|
||
| // CreateComment creates a new comment on an issue or PR | ||
| func (c *Client) CreateComment(ctx context.Context, issue IssueIdentifier, commentBody string) error { | ||
| _, _, err := c.client.Issues.CreateComment(ctx, issue.Owner, issue.Repo, issue.Number, &github.IssueComment{ | ||
| Body: &commentBody, | ||
| }) | ||
|
|
||
| return err | ||
| } | ||
|
|
||
| // UpdateComment updates an existing comment on an issue or PR | ||
| func (c *Client) UpdateComment(ctx context.Context, issue IssueIdentifier, commentId int64, commentBody string) error { | ||
| _, _, err := c.client.Issues.EditComment(ctx, issue.Owner, issue.Repo, commentId, &github.IssueComment{ | ||
| Body: &commentBody, | ||
| }) | ||
|
|
||
| return err | ||
| } |
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| build/* |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| TOOL_NAME = amplify-preview | ||
|
|
||
| include ../repo-release-tooling/tooling.mk |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| # amplify-preview | ||
|
|
||
|
|
||
| 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), | ||
| however because of following limitations, we can't really use it for some of the repos: | ||
| - [No way to filter for which PRs to generate preview deployments](https://github.com/aws-amplify/amplify-hosting/issues/3960) | ||
| - [Hard limit of 50 preview branches per amplify app][https://docs.aws.amazon.com/amplify/latest/userguide/quotas-chapter.html] | ||
| - [No way to create PR preview programmatically](https://github.com/aws-amplify/amplify-hosting/issues/3963) | ||
|
|
||
| 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. | ||
|
|
||
| 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. | ||
| If `--wait` is enabled, then it will also wait for deployment to be completed and fail the GHA run if deployment had failed. | ||
|
|
||
| ## Usage | ||
|
|
||
| ```shell | ||
| usage: amplify-preview --amplify-app-ids=AMPLIFY-APP-IDS --git-branch-name=GIT-BRANCH-NAME [<flags>] | ||
|
|
||
| Flags: | ||
| --[no-]help Show context-sensitive help (also try --help-long and --help-man). | ||
| --amplify-app-ids=AMPLIFY-APP-IDS ... | ||
| List of Amplify App IDs ($AMPLIFY_APP_IDS) | ||
| --git-branch-name=GIT-BRANCH-NAME | ||
| Git branch name ($GIT_BRANCH_NAME) | ||
| --[no-]create-branches Defines whether Amplify branches should be created if missing, or just lookup existing ones ($CREATE_BRANCHES) | ||
| --[no-]wait Wait for pending/running job to complete ($WAIT) | ||
| ``` | ||
| Example GHA workflow: | ||
| ```yaml | ||
| name: Amplify Preview | ||
| on: | ||
| pull_request: | ||
| paths: | ||
| - 'docs/**' | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| # Permissions to write PR comment | ||
| pull-requests: write | ||
| id-token: write | ||
|
|
||
| jobs: | ||
| amplify-preview: | ||
| name: Get and post Amplify preview URL | ||
| runs-on: ubuntu-22.04-2core-arm64 | ||
| environment: docs-amplify | ||
| steps: | ||
| - name: Checkout shared-workflow | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| repository: gravitational/shared-workflows | ||
| sparse-checkout: | | ||
| tools | ||
|
|
||
| - name: Configure AWS credentials | ||
| uses: aws-actions/configure-aws-credentials@e3dd6a429d7300a6a4c196c26e071d42e0343502 # v4 | ||
| with: | ||
| aws-region: us-west-2 | ||
| role-to-assume: ${{ vars.IAM_ROLE }} | ||
|
|
||
| - name: Check Amplify job status test | ||
| uses: ./tools/amplify-preview | ||
| with: | ||
| app_ids: ${{ vars.AMPLIFY_APP_IDS }} | ||
| create_branches: "true" | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| wait: "true" | ||
| ``` | ||
| ## AWS Permissions | ||
| For this action to work, AWS role with following IAM permissions is required: | ||
| ```json | ||
| { | ||
| "Statement": [ | ||
| { | ||
| "Action": [ | ||
| "amplify:CreateBranch", | ||
| "amplify:GetBranch", | ||
| "amplify:ListJobs" | ||
| "amplify:StartJob", | ||
| ], | ||
| "Effect": "Allow", | ||
| "Resource": [ | ||
| "arn:aws:amplify:<region>:<account_id>:apps/<app_id>/branches/*" | ||
| ] | ||
| } | ||
| ], | ||
| "Version": "2012-10-17" | ||
| } | ||
| ``` | ||
| Where `amplify:CreateBranch` and `amplify:StartJob` are needed only when `--create-branches` is enabled. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| name: Amplify Preview | ||
| description: Prepare Amplify Preview URL and post it in PR comments | ||
| inputs: | ||
| app_ids: | ||
| description: "Comma separated list of Amplify App IDs" | ||
| required: true | ||
| create_branches: | ||
| description: 'Create preview branches using this actions instead of "auto-build" feature on AWS Amplify' | ||
| required: false | ||
| default: "false" | ||
| github_token: | ||
| required: true | ||
| description: "Github token with permissions to read/write comments in pull request" | ||
| wait: | ||
| default: "false" | ||
| description: "If Amplify deployment is pending/running state wait for it's completion" | ||
| runs: | ||
| using: composite | ||
| steps: | ||
| - name: Extract branch name | ||
| shell: bash | ||
| run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT | ||
| id: extract_branch | ||
|
|
||
| - uses: actions/setup-go@v5 | ||
| with: | ||
| go-version-file: tools/amplify-preview/go.mod | ||
| cache-dependency-path: tools/amplify-preview/go.sum | ||
|
|
||
| - name: Amplify Preview | ||
| env: | ||
| AMPLIFY_APP_IDS: ${{ inputs.app_ids }} | ||
| GIT_BRANCH_NAME: ${{ steps.extract_branch.outputs.branch }} | ||
| CREATE_BRANCHES: ${{ inputs.create_branches }} | ||
| GITHUB_TOKEN: ${{ inputs.github_token }} | ||
| WAIT: ${{ inputs.wait }} | ||
| shell: bash | ||
| run: | | ||
| pushd ./tools/amplify-preview/; go run ./; popd |
Oops, something went wrong.