Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

38 lines (25 loc) · 1.79 KB

Contribution Guidelines

For more information on how this repository was set up, check out this Confluence how-to page on how to bootstrap AWS accounts.

Setting up the repository for development

You must first install pipenv and the AWS CLI.

For testing, you can use the workflows-nextflow-dev AWS account that was set up here. You can open an issue to request for access to the AWS account. One of the project admins will create an IAM user in this AWS account and share the credentials in a secure way.

# Create directory for remote sceptre templates
mkdir -p templates/remote/

# Install dependencies in isolated virtual environment
pipenv install --dev

# Install pre-commit hooks into Git
pipenv run pre-commit install

# Set up an AWS CLI profile with admin access for a test account
aws configure --profile $AWS_PROFILE

Testing sceptre deployment

If your text editor (e.g. Visual Studio Code) or shell (e.g. using direnv) can automatically activate the pipenv virtual environment, you can omit the pipenv shell command.

# Activate the pipenv virtual environment to use sceptre
pipenv shell

# Test the deployment of the 'prod' stack group
sceptre --var "profile=$AWS_PROFILE" launch --yes prod

# Delete the test deployment of the 'prod' stack group
sceptre --var "profile=$AWS_PROFILE" delete --yes prod