Skip to content

Commit d9e0dc8

Browse files
committed
feat: add upload action
1 parent bbf34c7 commit d9e0dc8

File tree

6 files changed

+234
-58
lines changed

6 files changed

+234
-58
lines changed

README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Actions - s3-website-pr-action 🚀 ![Main Workflow](https://github.com/danburtenshaw/s3-website-pr-action/workflows/Main%20Workflow/badge.svg) ![Github Actions Marketplace](https://img.shields.io/badge/Marketplace-Github%20Action-brightgreen)
1+
# Actions - s3-website-pr-action 🚀
22

33
### Automatically deploy built PR bundles to an S3 static website
44

@@ -43,22 +43,22 @@ The site url will be posted as a comment on the pull request.
4343
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)
4444

4545
### 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 |
5151

5252
### 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 |
5757

5858
### 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-' |
6262

6363

6464
## PR closed:
@@ -86,21 +86,21 @@ build:
8686
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.
8787

8888
### 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 |
9494

9595
### 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 |
9999

100100
### 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-' |
104104

105105
# IAM 🔐
106106

0 commit comments

Comments
 (0)