SERVICES.YML

The problem

Rails apps often use a dozen or more third-party services and it can quickly become difficult to remember which services are used by the app, especially when working with many apps.

The solution

We can fix this by adding a list of services to our app.

The list should:

Be named SERVICES.YML
Be stored in the root of the app
Use the YAML format when possible
Use single words to describe service types
Start with the hosting provider
Place all other service types in alphabetical order
Be updated when you change service providers

Example

advertising: google
analytics: plausible
ci: github
email:
  transactional: postmark
  spam: akismet
hosting: digitalocean
mapping:
  geocoding: google
  maps: apple
monitoring: sentry
payments: stripe
storage:
  amazon:
    - cloudfront
    - s3

This example file contains several common service types. But you should use whatever service types make sense for your app.

FAQ

Why not just use ENV variables?

ENV variables are used to store app secrets and other configuration settings. We want a short list that we can read and understand in a glance.

Why not just use a Gemfile?

Gemfiles are used to manage dependencies. Usually, most gems in a Gemfile are not service related, so that makes it harder to find the ones that are services.

Why not just use a README?

README files are often very long and take a considerable amount of time to read.

Do I have to use valid YAML?

No, not at all. Just start with YAML. But, if you need to use non-YAML syntax later, that’s fine. This is your list.

Is this format supposed to be machine-parseable?

Not really, but you’re welcome to do so.

Can I use this without Rails?

Sure! This format can be used with any kind of web app.