flemay / envvars Goto Github PK

If you're not already familiar with envvars, it's probably not intuitive to go looking in envvars.yml when you get an error about unset variables. The description for the variable will be really useful if you need to set it, so an easy way to surface this information is in the error from envvar ensure.

I don't know if this is trying to solve a problem in the wrong place, but I have reached a conclusion it might be useful to specify a list of allowed values for env vars when using this tool. A validator of sorts:

Example:

envvars:
  - name: ENV
    desc: Application stage (dev, qa, preprod, prod)
    tags:
      - deploy
    optional: true
    example: dev
    values:
        - dev
        - qa
        - preprod
        - prod

I'd be happy to flex my go muscles and contribute this, just want to get some input before I do :)

currently if we don't have an example

envvars:
  - name: AWS_DEFAULT_REGION
    desc: AWS Region to deploy to
    tags:
      - aws

the .env file will be generated like

AWS_DEFAULT_REGION

But i think it should be like

AWS_DEFAULT_REGION=

This can also prevent issue if i use envvars envfile to generate a .env and later invoke docker-compose with it.

i can submit a small pr to get it fixed if you think it makes sense.

Given that dockerhub rate limits quite aggressively these days, I'm frequently having to set up private repos to host this image. Any chance we can also get it hosted elsewhere? Public ECR is pretty good.

This prevents silent failures when encountering syntax errors in the envvars command

It would be nice to pass a list of examples instead of being limited to one.

envvars:
  - name: ENV
    description: Application environment
    examples:
      - prod
      - dev
    tags:
      - deploy