├── README.md ├── index.py └── LICENSE /README.md: -------------------------------------------------------------------------------- 1 | 2 | # Static site generator plugin: Hugo 3 | 4 | This is a static site generator plugin for the [AWS Git-backed static 5 | website stack][stack]. This plugin treats the Git repository content 6 | as source for [Hugo][hugo], a static website generator. 7 | 8 | This plugin takes the form of an AWS Lambda function that is deployed 9 | in a ZIP file in an S3 bucket. When the static website stack is 10 | created with CloudFormation, the site generator AWS Lambda function 11 | parameters are pointed to the ZIP file in the S3 bucket, causing the 12 | AWS Lambda function to be created and run in the new stack. 13 | 14 | When the stack is running and the CodeCommit Git repository contents 15 | are updated, CodePipeline automatically invokes this AWS Lambda 16 | function, providing it a ZIP file of the CodeCommit Git branch 17 | contents. This function turns that site source into the static web 18 | site contents, and passes back a ZIP file. The stack then syncs that 19 | content to the S3 bucket that serves the static website. 20 | 21 | This Hugo static site generator plugin runs the following command: 22 | 23 | ./hugo --source=SOURCEDIR --destination=SITEDIR 24 | 25 | where SOURCEDIR contains the content of the CodeCommit Git repository, 26 | and SITEDIR is the resulting content that will be sync'd to the S3 27 | bucket serving the static website. 28 | 29 | When passing parameters to the AWS Git-backed static website 30 | CloudFormation template, specify: 31 | 32 | - **GeneratorLambdaFunctionS3Bucket** - The S3 bucket containing this 33 | AWS Lambda function ZIP file. E.g., "run.alestic.com" 34 | 35 | - **GeneratorLambdaFunctionS3Key** - The S3 key containing this AWS 36 | Lambda function ZIP file. E.g., 37 | "lambda/aws-lambda-site-generator-hugo.zip" 38 | 39 | - **GeneratorLambdaFunctionRuntime** - "python2.7" 40 | 41 | - **GeneratorLambdaFunctionHandler** - "index.handler" 42 | 43 | - **GeneratorLambdaFunctionUserParameters** - If this value starts 44 | with a dash (-) then it will be appended to the hugo command 45 | line. If it does not start with a dash, then it will be ignored. 46 | 47 | You may use this value to specify options like "--theme THEMENAME". 48 | 49 | People with warped minds could stick a semicolon (;) in this 50 | CloudFormation template parameter and run arbitrary static site 51 | post-processing commands in the AWS Lambda environment. This is not 52 | recommended and is not guaranteed to be supported in future 53 | versions. Better to fork and modify this repository to customize an 54 | AWS Lambda function plugin to your needs. 55 | 56 | Here is a sample stack creation command using aws-cli: 57 | 58 | domain=example.com 59 | email=yourrealemail@anotherdomain.com 60 | 61 | template_url=https://s3.amazonaws.com/run.alestic.com/cloudformation/aws-git-backed-static-website-cloudformation.yml 62 | stackname=${domain/./-}-$(date +%Y%m%d-%H%M%S) 63 | region=us-east-1 64 | 65 | aws cloudformation create-stack \ 66 | --region "$region" \ 67 | --stack-name "$stackname" \ 68 | --capabilities CAPABILITY_IAM \ 69 | --template-url "$template_url" \ 70 | --tags "Key=Name,Value=$stackname" \ 71 | --parameters \ 72 | "ParameterKey=DomainName,ParameterValue=$domain" \ 73 | "ParameterKey=NotificationEmail,ParameterValue=$email" \ 74 | "ParameterKey=GeneratorLambdaFunctionS3Bucket,ParameterValue=run.alestic.com" \ 75 | "ParameterKey=GeneratorLambdaFunctionS3Key,ParameterValue=lambda/aws-lambda-site-generator-hugo.zip" 76 | echo region=$region stackname=$stackname 77 | 78 | The important point in the above command is the last two "Generator*" 79 | parameters, which specify the location of the Hugo AWS Lambda static 80 | site generator plugin. 81 | 82 | See the main [AWS Git-backed static website stack][stack] 83 | documentation for more details on how to work with the stack once it 84 | is launched. 85 | 86 | [stack]: https://github.com/alestic/aws-git-backed-static-website 87 | [hugo]: https://gohugo.io/ 88 | -------------------------------------------------------------------------------- /index.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3.9 2 | # 3 | # AWS Lambda function static site generator plugin: Hugo 4 | # 5 | # This Lambda function is invoked by CodePipeline. It performs these actions: 6 | # - Download file from the CodePipeline artifact S3 bucket and unZIP 7 | # - Generate the static website from the source 8 | # - ZIP and upload the new site contents to the CodePipeline artifact S3 bucket 9 | # - Notify CodePipeline of the results (success or failure) 10 | # 11 | from __future__ import print_function 12 | from boto3.session import Session 13 | import boto3 14 | import botocore 15 | import os 16 | import zipfile 17 | import tempfile 18 | import shutil 19 | import shlex 20 | import subprocess 21 | import traceback 22 | 23 | code_pipeline = boto3.client('codepipeline') 24 | 25 | def setup(event): 26 | # Extract attributes passed in by CodePipeline 27 | job_id = event['CodePipeline.job']['id'] 28 | job_data = event['CodePipeline.job']['data'] 29 | input_artifact = job_data['inputArtifacts'][0] 30 | config = job_data['actionConfiguration']['configuration'] 31 | credentials = job_data['artifactCredentials'] 32 | from_bucket = input_artifact['location']['s3Location']['bucketName'] 33 | from_key = input_artifact['location']['s3Location']['objectKey'] 34 | from_revision = input_artifact['revision'] 35 | output_artifact = job_data['outputArtifacts'][0] 36 | to_bucket = output_artifact['location']['s3Location']['bucketName'] 37 | to_key = output_artifact['location']['s3Location']['objectKey'] 38 | user_parameters = config['UserParameters'] 39 | 40 | # Temporary credentials to access CodePipeline artifacts in S3 41 | key_id = credentials['accessKeyId'] 42 | key_secret = credentials['secretAccessKey'] 43 | session_token = credentials['sessionToken'] 44 | session = Session(aws_access_key_id=key_id, 45 | aws_secret_access_key=key_secret, 46 | aws_session_token=session_token) 47 | s3 = session.client('s3', 48 | config=botocore.client.Config(signature_version='s3v4')) 49 | 50 | return (job_id, s3, from_bucket, from_key, from_revision, 51 | to_bucket, to_key, user_parameters) 52 | 53 | def download_source(s3, from_bucket, from_key, from_revision, source_dir): 54 | with tempfile.NamedTemporaryFile() as tmp_file: 55 | #TBD: from_revision is not used here! 56 | s3.download_file(from_bucket, from_key, tmp_file.name) 57 | with zipfile.ZipFile(tmp_file.name, 'r') as zip: 58 | zip.extractall(source_dir) 59 | 60 | def upload_site(site_dir, s3, to_bucket, to_key): 61 | with tempfile.NamedTemporaryFile() as tmp_file: 62 | site_zip_file = shutil.make_archive(tmp_file.name, 'zip', site_dir) 63 | s3.upload_file(site_zip_file, to_bucket, to_key) 64 | 65 | def handler(event, context): 66 | try: 67 | (job_id, s3, from_bucket, from_key, from_revision, 68 | to_bucket, to_key, user_parameters) = setup(event) 69 | 70 | # Directories for source content, and transformed static site 71 | source_dir = tempfile.mkdtemp() 72 | site_dir = tempfile.mkdtemp() 73 | 74 | # Download and unzip the source for the static site 75 | download_source(s3, from_bucket, from_key, from_revision, source_dir) 76 | 77 | # Generate static website from source 78 | generate_static_site(source_dir, site_dir, user_parameters) 79 | 80 | # ZIP and and upload transformed contents for the static site 81 | upload_site(site_dir, s3, to_bucket, to_key) 82 | 83 | # Tell CodePipeline we succeeded 84 | code_pipeline.put_job_success_result(jobId=job_id) 85 | 86 | except Exception as e: 87 | print("ERROR: " + repr(e)) 88 | traceback.print_exc() 89 | # Tell CodePipeline we failed 90 | code_pipeline.put_job_failure_result(jobId=job_id, failureDetails={'message': e, 'type': 'JobFailed'}) 91 | 92 | finally: 93 | shutil.rmtree(source_dir) 94 | shutil.rmtree(site_dir) 95 | 96 | return "complete" 97 | 98 | def workaround_timestamps(site_dir): 99 | # ZIP can't handle files older than 1970 100 | # Temporary workaround for bad dates in submodules. 101 | command = ["find", site_dir, "-mtime", "+10950", "-exec", "touch", "{}", ";"] 102 | print(command) 103 | try: 104 | print(subprocess.check_output(command, stderr=subprocess.STDOUT)) 105 | except subprocess.CalledProcessError as e: 106 | print("ERROR return code (find): ", e.returncode) 107 | print("ERROR output (find): ", e.output) 108 | raise 109 | 110 | def generate_static_site(source_dir, site_dir, user_parameters): 111 | # Run Hugo static site generator 112 | command = ["./hugo", "--source=" + source_dir, "--destination=" + site_dir] 113 | if user_parameters.startswith("-"): 114 | command.extend(shlex.split(user_parameters)) 115 | print(command) 116 | try: 117 | print(subprocess.check_output(command, stderr=subprocess.STDOUT)) 118 | except subprocess.CalledProcessError as e: 119 | print("ERROR return code: ", e.returncode) 120 | print("ERROR output: ", e.output) 121 | raise 122 | # workaround_timestamps(site_dir) 123 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 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. 202 | --------------------------------------------------------------------------------