Skip to content

Latest commit

 

History

History
87 lines (65 loc) · 3.61 KB

README.md

File metadata and controls

87 lines (65 loc) · 3.61 KB
Raw

Static site generator plugin: Hugo

This is a static site generator plugin for the AWS Git-backed static website stack. This plugin treats the Git repository content as source for Hugo, a static website generator.

This plugin takes the form of an AWS Lambda function that is deployed in a ZIP file in an S3 bucket. When the static website stack is created with CloudFormation, the site generator AWS Lambda function parameters are pointed to the ZIP file in the S3 bucket, causing the AWS Lambda function to be created and run in the new stack.

When the stack is running and the CodeCommit Git repository contents are updated, CodePipeline automatically invokes this AWS Lambda function, providing it a ZIP file of the CodeCommit Git branch contents. This function turns that site source into the static web site contents, and passes back a ZIP file. The stack then syncs that content to the S3 bucket that serves the static website.

This Hugo static site generator plugin runs the following command:

./hugo --source=SOURCEDIR --destination=SITEDIR

where SOURCEDIR contains the content of the CodeCommit Git repository, and SITEDIR is the resulting content that will be sync'd to the S3 bucket serving the static website.

When passing parameters to the AWS Git-backed static website CloudFormation template, specify:

  • GeneratorLambdaFunctionS3Bucket - The S3 bucket containing this AWS Lambda function ZIP file. E.g., "run.alestic.com"

  • GeneratorLambdaFunctionS3Key - The S3 key containing this AWS Lambda function ZIP file. E.g., "lambda/aws-lambda-site-generator-hugo.zip"

  • GeneratorLambdaFunctionRuntime - "python2.7"

  • GeneratorLambdaFunctionHandler - "index.handler"

  • GeneratorLambdaFunctionUserParameters - If this value starts with a dash (-) then it will be appended to the hugo command line. If it does not start with a dash, then it will be ignored.

    You may use this value to specify options like "--theme THEMENAME".

    People with warped minds could stick a semicolon (;) in this CloudFormation template parameter and run arbitrary static site post-processing commands in the AWS Lambda environment. This is not recommended and is not guaranteed to be supported in future versions. Better to fork and modify this repository to customize an AWS Lambda function plugin to your needs.

Here is a sample stack creation command using aws-cli:

domain=example.com
[email protected]

template_url=https://s3.amazonaws.com/run.alestic.com/cloudformation/aws-git-backed-static-website-cloudformation.yml
stackname=${domain/./-}-$(date +%Y%m%d-%H%M%S)
region=us-east-1

aws cloudformation create-stack \
  --region "$region" \
  --stack-name "$stackname" \
  --capabilities CAPABILITY_IAM \
  --template-url "$template_url" \
  --tags "Key=Name,Value=$stackname" \
  --parameters \
    "ParameterKey=DomainName,ParameterValue=$domain" \
    "ParameterKey=NotificationEmail,ParameterValue=$email" \
    "ParameterKey=GeneratorLambdaFunctionS3Bucket,ParameterValue=run.alestic.com" \
    "ParameterKey=GeneratorLambdaFunctionS3Key,ParameterValue=lambda/aws-lambda-site-generator-hugo.zip"
echo region=$region stackname=$stackname

The important point in the above command is the last two "Generator*" parameters, which specify the location of the Hugo AWS Lambda static site generator plugin.

See the main AWS Git-backed static website stack documentation for more details on how to work with the stack once it is launched.