Skip to content

Commit 0d2329e

Browse files
henriqueleite42henriqueleite42
committed
Initial Commit
1 parent 42ac9a5 commit 0d2329e

File tree

7 files changed

+292
-19
lines changed

7 files changed

+292
-19
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## What this PR introduces?
2+
3+
Issue Number: N/A
4+
5+
<!-- Please, includes description of this pull request -->
6+
7+
## PR Checklist
8+
9+
Please check if your PR fulfills the following requirements:
10+
11+
- [ ] I followed GitFlow pattern to create the branch
12+
- [ ] The version of the example at `README.md` has been upgraded
13+
- [ ] The changes has been added to `CHANGELOG.md`
14+
- [ ] My code produces no warnings or errors
15+
16+
## PR Type
17+
18+
What kind of change does this PR introduce?
19+
20+
```
21+
[ ] Hotfix
22+
[ ] Bugfix
23+
[ ] Feature
24+
[ ] Documentation update
25+
[ ] Code style update (formatting, local variables)
26+
[ ] Refactoring (no functional changes, no api changes)
27+
[ ] CI/CD related changes
28+
[ ] Other: ...
29+
```
30+
31+
## Does this PR introduce a breaking change?
32+
33+
```
34+
[ ] Yes
35+
[ ] No
36+
```
37+
38+
<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
39+
40+
## Other information (Prints, details, etc)

‎CHANGELOG.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
## [1.0.0] - 2021-09-09
8+
9+
### Added
10+
11+
- Action to deploy static webapp to AWS S3 and clean cloudfront cache
12+
13+
### Changed
14+
15+
### Removed
16+
17+
### Updated

‎Dockerfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FROM amazon/aws-cli
1+
FROM amazon/aws-cli
22

33
ADD . /
44

‎LICENSE

+196-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
14

2-
The MIT License (MIT)
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
36

4-
Copyright (c) 2019 Peter Ukonu
7+
1. Definitions.
58

6-
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
711

8-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
914

10-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md

+24-4
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,36 @@
1-
# Github Actions - S3 and Cloudfront Invalidation
2-
This is a simple utility to deploy to AWS S3 bucket and invalidate a cloudfront id. It is that straightforward. See usage below
1+
# Github Actions - Deploy Static Webapp to S3 and Invalidates Cloudfront
2+
3+
This is a simple utility to deploy an static webapp to AWS S3 bucket and invalidate a cloudfront id. It is that straightforward.
34

45
### Usage:
6+
57
Just place this in your code underneath your build action within the steps, update the variables and secrets and that is it.
8+
69
```yaml
10+
11+
name: "Deploy To S3" #set whatever name you want to your github job
12+
13+
on: # set the events you would like to trigger this job
14+
push:
15+
branches: [master]
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v2
23+
24+
- name: Build
25+
run: # Build the project
26+
727
- name: Deploy application to AWS S3 and invalidate cloudfront cache
8-
uses: pukonu/action-deploy-webapp-aws@v.1.0
28+
uses: techmmunity/action-deploy-static-webapp-aws@1.0.0
929
id: deploy
1030
with:
1131
build_path: './path/to/build/folder'
1232
bucket_name: '<AWS BUCKET NAME>'
13-
bucket_key: ''
33+
bucket_key: '' # Optional
1434
distribution_invalidation_path: '/*'
1535
env:
1636
DISTRIBUTION_ID: '<DISTRIBUTION ID>'

‎action.yml

+7-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
name: 'Deploy Web App to AWS'
2-
description: 'Deploys a webapp to an AWS s3 bucket and then invalidates the cloudfront entry'
3-
author: 'Peter Ukonu'
1+
name: 'Deploy Static Webapp to AWS'
2+
description: 'Deploys a static webapp to an AWS s3 bucket and then invalidates the cloudfront entry'
3+
author: 'Techmmunity'
44
branding:
55
icon: 'arrow-up-circle'
66
color: 'blue'
@@ -9,19 +9,18 @@ inputs:
99
description: "The build path to deploy to s3"
1010
required: true
1111
bucket_name:
12-
description: "The AWS S3 bucket you will like to deployt to"
12+
description: "The AWS S3 bucket you will like to deploy to"
1313
required: true
1414
bucket_key:
1515
description: "The path of the folder you will to deploy to within the S3 bucket"
16-
required: true
17-
default: "/"
16+
required: false
1817
distribution_invalidation_path:
1918
description: "The path in cloudfront to invalidate"
2019
required: false
2120
default: "/*"
2221
outputs:
23-
aws-deploy-output:
24-
description: 'A json output from AWS on the deployment'
22+
aws-deploy-output:
23+
description: 'A json output from AWS on the deployment'
2524
runs:
2625
using: 'docker'
2726
image: 'Dockerfile'

‎script.sh

+7-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,13 @@ fi
4141
output="AWS OUTPUT"
4242
echo "::set-output name=aws-deploy-output::$output"
4343

44-
aws s3 cp $build_path s3://$bucket_name/$bucket_key --recursive
44+
# Only add the "/" if a buket_key is defined
45+
case "$bucket_key" in
46+
"") formatted_bucket_key="" ;;
47+
*) formatted_bucket_key="/$bucket_key" ;;
48+
esac
49+
50+
aws s3 cp $build_path s3://$bucket_name$formatted_bucket_key --recursive
4551

4652
if [ -z "$DISTRIBUTION_ID" ]; then
4753
echo "Skipping cloudfront invalidation..."

0 commit comments

Comments
 (0)