alvyn279 / aws-cdk-billing-alarm

CDK construct that sets up email alerts for AWS monthly bill

Hi, I'm Alvyn. 👋

• 🎓 Bachelor's of Software Engineering - Concordia University (2020)
• 💭 "A Leetcode a day keeps unemployment away" big lie i don't do that anymore
• 🌏 Usually I tell people to visit me on my website
• 🌳 Open-source contributor

🎾 🏒 🇨🇦 ⛳️ ⚽️ 🍔 🤠 🎿

Languages and Tools:

aws-cdk-billing-alarm's Issues

Remove useless files from NPM package

Context

Some files don't need to be packaged and published to npm.

Tasks

Remove:

• test/
• .github/
• jest.config.*

Alternatives

N/A

Notes

N/A

README supports dynamic documentation

Context

jsii has a really cool feature where the example Typescript code in README is transformed into the target language at package/publish time. This mean NPM and PyPi will respectively show working TS and Python code examples.

We need to play around that to ensure coherent installation steps and code samples are shown in the packages homepages.

Tasks

• Remove Typescript header
• Have both npm and pip install
• GitHub README will still show default README, so we need to include a statement for specific python example

Alternatives

Have both TS and Python install/code samples. Will clutter README.

Notes

N/A

Support Python construct

Context

It would be great if this construct would also be available in Python

Tasks

• Look into a jsii integration where TypeScript Construct code would be compiled and served as a ready-to-use Python module

Alternatives

N/A

Notes

N/A

Rename release tags

Bug Description

The latest release name does not need the 'Release ' prefix.

• We just need to modify publish.yml workflow that takes care of naming this entity.
• Maybe even take out the Pull requests header before the list of pull requests.

Reproduction Steps

Look at the repo's landing page.

Expected Behaviour

We just want the version number

Additional Context

N/A

Automate GitHub release through tags push

Context

It would be nice to create a release automatically through GitHub Actions every time a tag is pushed. This represents a challenge in terms of gathering release changes programatically.

Tasks

• Find a suitable GitHub Action

Alternatives

• https://github.com/actions/create-release
• https://github.com/ibnesayeed/repo-attrs

Notes

The v1 release (#1) could therefore be triggered by a tag push.

Support multiple emails

Context

It would be nice to notify more than one endpoint (email). This would be a breaking change.

Tasks

• API change for BillingAlarmProps from email to emails: Array<string>

Alternatives

Would it be better to support more than just EmailSubscription ?

Notes

N/A

Example has a bad reference to `stack`

Bug Description

The README code sample is wrong given that the construct is written in a stack.

new BillingAlarm(stack, 'AWSAccountBillingAlarm', {
      monthlyThreshold: 50,
      emails: ['[email protected]'],
    });

should be

new BillingAlarm(this, 'AWSAccountBillingAlarm', {
      monthlyThreshold: 50,
      emails: ['[email protected]'],
    });

Reproduction Steps

Look at README

Prepare for V1 release

Context

There is a lot of setup needed before releasing this construct library as an NPM package.

Tasks

• Build system:
  • Change build system to jsii with the following article
• README:
  • Pre-reqs and post installation
  • Working example
• Publish #2 on beta
• Function test

Alternatives

N/A

Notes

• Should probably function test beta in TS and Python when published to NPM and PyPi.

Set up Github Actions

Context

It would be good to build, test, and potentially release the application from GitHub Actions.

Tasks

• Set up build, linter and test workflow (on any PR or push to main)
• Publish can be done with jsii-publish
  • Npm can be set up with the following tutorial
  • Publish Python to PyPi
  • jsii allows TS to TS and python

Alternatives

N/A

Notes

This repository will be subject to max of 3000 build minutes while it is private.