@smg-automotive/configuration

SMG Automotive Configuration

It loads configuration for a specific stage via dotenv from .env/<CONFIG_ENV>. If no environment is provided it defaults to NODE_ENV.

You can add local overrides in .env/<CONFIG_ENV>.local. This is useful for temporary or local changes.

Usage

npm install @smg-automotive/configuration

Add the following line to your .gitignore

/.env/*.local

The configuration environment can be passed via CONFIG_ENV environment variable:

$ CONFIG_ENV=stage-prod npm run dev

In a nextjs project, you can call loadConfiguration() in next.config.js and pass the result to next as env, see https://nextjs.org/docs/api-reference/next.config.js/environment-variables - configuration values will be available on process.env both client- and server-side

const configuration = require("@smg-automotive/configuration")
module.exports = {
  env: configuration
}

In any node process, simply require the package in your entry point and access variables on process.env. Do this as early in the file as possible, ie. before requiring any files that are accessing config variables

require("@smg-automotive/configuration")

Development

npm run build

You can link your local npm package to integrate it with any local project:

cd configuration-pkg
npm run build

cd project
npm link ../configuration-pkg/dist

Release a new version

New versions are released on the ci using semantic-release as soon as you merge into master. Please make sure your merge commit message adheres to the corresponding conventions.

Circle CI

You will need to enable the repository in circle CI ui to be able to build it.

For slack notifications to work you will need to provide the token in circle settings.