awsutils

README

awsutils

This repo is comprised of aws utilities that I use across various go projects.

Dependencies

• Install pre-commit:

  python3 -m pip install --upgrade pip
  python3 -m pip install pre-commit
  

• Install Mage:

  go install github.com/magefile/mage@latest
  

• Install AWS CLI

---

For Contributors and Developers

1. Fork this project

2. Install dependencies:

   mage installDeps
   

3. Update and run pre-commit hooks locally:

   mage runPreCommit
   

---

Create New Release

• Download and install the gh cli tool:

  • macOS
  • Linux
  • Windows

• Install changelog extension:

  gh extension install chelnak/gh-changelog
  

• Generate changelog:

  NEXT_VERSION=v1.1.3
  gh changelog new --next-version "${NEXT_VERSION}"
  

• Create release:

  gh release create "${NEXT_VERSION}" -F CHANGELOG.md
  

---

Developer Environment Setup

1. Fork this project

2. Update and run pre-commit hooks locally:

   mage runPreCommit
   

3. If running tests, create a test_env file from test_env_template and fill out all TODO values.

   Once all vars are filled out, export them:

   source test_env
   

   Alternatively, you can debug with vscode by removing the export statements in front of each variable.