|
1 | | -# Actions - s3-website-pr-action 🚀   |
| 1 | +# Actions - s3-website-pr-action 🚀 |
2 | 2 |
|
3 | 3 | ### Automatically deploy built PR bundles to an S3 static website |
4 | 4 |
|
@@ -43,22 +43,22 @@ The site url will be posted as a comment on the pull request. |
43 | 43 | Note: By default, workflows using the `pull_request` activity type will include the above events. [Docs](https://help.github.com/en/actions/reference/events-that-trigger-workflows#pull-request-event-pull_request) |
44 | 44 |
|
45 | 45 | ### Required Environment Variables |
46 | | -Environment Variable | Description |
47 | | ------------- | ------------- |
48 | | -AWS_ACCESS_KEY_ID | AWS Access Key ID of an IAM user |
49 | | -AWS_SECRET_ACCESS_KEY | AWS Secret Access Key of an IAM user |
50 | | -GITHUB_TOKEN | GitHub automatically provides the secret value |
| 46 | +| Environment Variable | Description | |
| 47 | +| --------------------- | ---------------------------------------------- | |
| 48 | +| AWS_ACCESS_KEY_ID | AWS Access Key ID of an IAM user | |
| 49 | +| AWS_SECRET_ACCESS_KEY | AWS Secret Access Key of an IAM user | |
| 50 | +| GITHUB_TOKEN | GitHub automatically provides the secret value | |
51 | 51 |
|
52 | 52 | ### Required Parameters |
53 | | -Parameter | Description |
54 | | ------------- | ------------- |
55 | | -bucket-prefix | Prefix to the S3 bucket name |
56 | | -folder-to-copy | The directory to your built web app. This folder will be copied to S3 |
| 53 | +| Parameter | Description | |
| 54 | +| -------------- | --------------------------------------------------------------------- | |
| 55 | +| bucket-prefix | Prefix to the S3 bucket name | |
| 56 | +| folder-to-copy | The directory to your built web app. This folder will be copied to S3 | |
57 | 57 |
|
58 | 58 | ### Optional Parameters |
59 | | -Parameter | Description |
60 | | ------------- | ------------- |
61 | | -environment-prefix | Prefix to the GitHub Deployment. Defaults to 'PR-' |
| 59 | +| Parameter | Description | |
| 60 | +| ------------------ | -------------------------------------------------- | |
| 61 | +| environment-prefix | Prefix to the GitHub Deployment. Defaults to 'PR-' | |
62 | 62 |
|
63 | 63 |
|
64 | 64 | ## PR closed: |
@@ -86,21 +86,21 @@ build: |
86 | 86 | Execute the `s3-website-pr-action` action on pull request `closed` events. This will remove the S3 bucket that was created in the previous stage. |
87 | 87 |
|
88 | 88 | ### Required Environment Variables |
89 | | -Environment Variable | Description |
90 | | ------------- | ------------- |
91 | | -AWS_ACCESS_KEY_ID | AWS Access Key ID of an IAM user |
92 | | -AWS_SECRET_ACCESS_KEY | AWS Secret Access Key of an IAM user |
93 | | -GITHUB_TOKEN | GitHub automatically provides the secret value |
| 89 | +| Environment Variable | Description | |
| 90 | +| --------------------- | ---------------------------------------------- | |
| 91 | +| AWS_ACCESS_KEY_ID | AWS Access Key ID of an IAM user | |
| 92 | +| AWS_SECRET_ACCESS_KEY | AWS Secret Access Key of an IAM user | |
| 93 | +| GITHUB_TOKEN | GitHub automatically provides the secret value | |
94 | 94 |
|
95 | 95 | ### Required Parameters |
96 | | -Parameter | Description |
97 | | ------------- | ------------- |
98 | | -bucket-prefix | Prefix to the S3 bucket name. This should be the same value as the other stage |
| 96 | +| Parameter | Description | |
| 97 | +| ------------- | ------------------------------------------------------------------------------ | |
| 98 | +| bucket-prefix | Prefix to the S3 bucket name. This should be the same value as the other stage | |
99 | 99 |
|
100 | 100 | ### Optional Parameters |
101 | | -Parameter | Description |
102 | | ------------- | ------------- |
103 | | -environment-prefix | Prefix to the GitHub Deployment. Defaults to 'PR-' |
| 101 | +| Parameter | Description | |
| 102 | +| ------------------ | -------------------------------------------------- | |
| 103 | +| environment-prefix | Prefix to the GitHub Deployment. Defaults to 'PR-' | |
104 | 104 |
|
105 | 105 | # IAM 🔐 |
106 | 106 |
|
|
0 commit comments