guardian / tag-janitor

Placeholder description: @stephengeller created this with repo-genesis
0 stars 0 forks source link
production

= Tag Janitor

== What is it

Many of the Guardian's applications identify and interact with each other through looking up these three sets of tags:

This application:

  1. Queries https://github.com/guardian/prism[Prism] for instances
  2. Checks which ones are missing the required tags
  3. Notifies the relevant owners of those instances via https://github.com/guardian/anghammarad[Anghammarad]

== How to run locally

If you want to run this locally, you will need to:

  1. Set up your environment by creating a .env file in the lambda directory.
  2. Ensure you have correct credentials for the AWS account that Anghammarad lives in

Then, install the dependencies and run the code:

[source,bash]

$ cd lambda $ yarn # install dependencies $ yarn start # runs the handler locally

Or, run scripts/start.sh to do this for you!

== How to run the tests

Install all dependencies and run the tests from the lamdba directory:

[source,bash]

$ cd lambda $ yarn # installs dependencies $ yarn test

== How to deploy

Deploy this app through TeamCity and RiffRaff. See what CI is doing in scripts/ci.sh