Skip to content

Latest commit

 

History

History
104 lines (75 loc) · 4.45 KB

CONTRIBUTING.md

File metadata and controls

104 lines (75 loc) · 4.45 KB
Raw

Contributing Guidelines

Contributing via Pull Requests

1. Fork this repo

[IMPORTANT]: Write access is not provided to this repo. Please be sure to work in your fork

Use fork button in the GitHub UI

Screen Shot 2022-07-14 at 9 34 41 AM

2. Clone your repo and develop the asset

[From your local terminal] Run git clone <repo url>

Note: Repo url is within your git user namespace so you will have write access to it

Add your code to /template/name_of_cfntemplate.yaml

3. Setting up testing toolkit (recommended)

3a. Setup a python env (3.8.x <3.9).

3b. Setup a default aws profile

Example of 3b.: more info here https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html
[default]
aws_access_key_id=AKIAIOSFODNN7EXAMPLE
aws_secret_access_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

3c. Install taskcat

[From your local terminal] Run pip3 install taskcat

Note: For more info on taskcat see http://taskcat.io

3d. Test your code

Note: Template name much match in taskcat.yml

Example: .taskcat.yml (a sample is in the root of the repo)
tests:
  nameoftest:
    parameters:
      Param1: 'Inputs to Stack'
    regions: ## Regions to test in
    - us-east-1
    template: templates/name_of_cfntemplate.yaml <# Change to the name of template

[From your local terminal] Run taskcat test run

Example Output:
 _            _             _
| |_ __ _ ___| | _____ __ _| |_
| __/ _` / __| |/ / __/ _` | __|
| || (_| \__ \   < (_| (_| | |_
 \__\__,_|___/_|\_\___\__,_|\__|


version 0.9.30
[INFO   ] : Linting passed for file: /Users/tonynv/work/github/aws-quickstart/cfn-template/templates/sample-yaml.template
[S3: -> ] s3://tcat-cfn-template-553r8x5x/cfn-template/LICENSE
[S3: -> ] s3://tcat-cfn-template-553r8x5x/cfn-template/CODEOWNERS
[S3: -> ] s3://tcat-cfn-template-553r8x5x/cfn-template/NOTICE.txt
[S3: -> ] s3://tcat-cfn-template-553r8x5x/cfn-template/scripts/scripts_userdata.sh
[S3: -> ] s3://tcat-cfn-template-553r8x5x/cfn-template/templates/sample-yaml.template
[INFO   ] : ┏ stack Ⓜ tCaT-cfn-template-sample-304f89e2a420412e842b8d9fb66e102e
[INFO   ] : ┣ region: us-east-1
[INFO   ] : ┗ status: CREATE_COMPLETE
[INFO   ] : Reporting on arn:aws:cloudformation:us-east-1:************:stack/tCaT-cfn-template-sample-304f89e2a420412e842b8d9fb66e102e/6327faf0-038d-11ed-86d3-0ae8b573018d 
[INFO   ] : Deleting stack: arn:aws:cloudformation:us-east-1:************:stack/tCaT-cfn-template-sample-304f89e2a420412e842b8d9fb66e102e/6327faf0-038d-11ed-86d3-0ae8b573018d 
[INFO   ] : ┏ stack Ⓜ tCaT-cfn-template-sample-304f89e2a420412e842b8d9fb66e102e
[INFO   ] : ┣ region: us-east-1                                                                                         
[INFO   ] : ┗ status: DELETE_COMPLETE

4. Licensing

  • When adding new dependencies, contributors should verify that any third-party packages or libraries they add have a compatible license. We also encourage contributors to run the dependency. scanning script dependency-licenses.sh to check Go and Python dependencies for proper licensing.
  • Before running the script, set the Go environment variable GOPATH to $HOME/go . Make sure $HOME/.local/bin is added to system PATH.
  • Contributors should ensure that any required licenses are added to THIRD_PARTY_LICENSES if they are not already present.

5. Submit for Publication

(Raise a PR to the upstream repo from your fork)

When a Pull Request is raised against the upstream repo.

  • Automated tests will run and provide you instant feedback. When all Check have PR Check have PASSED and functional test will begin (code in all regions specfied in .taskcat.yml). If these tests pass the PR will be merged to main and synced to S3

For more information, see the Contributor's & Builder's Guide for CloudFormation-based AWS Partner Solutions

Reporting Bugs/Feature Requests

When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:

  • A reproducible test case or series of steps
  • The version of our code being used
  • Any modifications you've made relevant to the bug
  • Anything unusual about your environment or deployment