Skip to content

Commit

Permalink
Merge pull request zendesk#3101 from zendesk/bcolfer/small_README_imp…
Browse files Browse the repository at this point in the history
…rovements

Small README improvements to emphasize the format of the repo reference.
  • Loading branch information
bcolferzd authored Dec 27, 2018
2 parents 717750e + a14188d commit 2bd2bee
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion plugins/env/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ for a project and deploy_group.

## GitHub to manage environment variables
This plugin has an option to use a GitHub repository as source for environment variables.
The DEPLOYMENT_ENV_REPO must be set in samson's start up. Each project must opt-in to it via project settings.
The DEPLOYMENT_ENV_REPO must be set in samson's start up to be the `organization/repo`.

Each project must opt-in to it via project settings.

The expected structure of this repository is a directory named `generated` with a sub directory for each
_project permalink_ samson deploys. Within this directory for a project are the deploy group .env files using the name
Expand Down Expand Up @@ -37,3 +39,5 @@ RAILS_THREAD_MAX=5
The generated enviornment variables is the merger of deploy_group env variables, if the samson `deploy_group plugin` is
activated, the `project` environment variables in the samson database and the environment variables in the github `repo`.
The order of precedence for variables with the same key name: `deploy_group` replaces `project` which replaces `repo` variables.

*The variables in the Samson database overwrite any variables in the repo.*

0 comments on commit 2bd2bee

Please sign in to comment.