Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃殮(config) rename custom configuration files #23

Merged
merged 1 commit into from
May 21, 2018

Conversation

jmaupetit
Copy link
Contributor

Purpose

We need to make settings override via YAML files more generic.

Proposal

Expected configurations files names to override settings are now:

  • settings.yml (prev. settings.yaml) as the .yml extension is more
    oftlenly used than .yaml.
  • secrets.yml (prev. credentials.vault.yml) as we try to make
    the generation of this file independent from ansible (vault).

I've also slightly fixed docstrings/comments formatting (black style) 馃槈

@jmaupetit jmaupetit self-assigned this May 21, 2018
@jmaupetit jmaupetit requested a review from sampaccoud May 21, 2018 10:40
# Load the content of a `settings.yaml` file placed in the current directory if any
# This file is where customisable settings are stored for a given environment
# Load the content of a `settings.yml` file placed in the current
# directory if any This file is where customizable settings are stored
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing a dot

# Load the content of a `credentials.vault.yaml` file placed in the current directory if
# any. This file is where sensitive settings are stored for a given environment
# Load the content of a `secrets.yml` file placed in the current
# directory if any. This file is where sensitive settings are stored for
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/settings/credentials

Copy link
Contributor

@sampaccoud sampaccoud left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor typos otherwise GTM.

Expected configurations files names to override settings are now:

* `settings.yml` (prev. `settings.yaml`) as the `.yml` extension is more
   oftlenly used than `.yaml`.
* `secrets.yml` (prev. `credentials.vault.yml`) as we try to make
  the generation of this file independent from ansible (vault).
@jmaupetit jmaupetit force-pushed the fix-custom-settings-file-names branch from fc33f63 to 2c4828d Compare May 21, 2018 12:26
@jmaupetit jmaupetit merged commit 9374d04 into master May 21, 2018
@jmaupetit jmaupetit deleted the fix-custom-settings-file-names branch May 21, 2018 12:42
jmaupetit added a commit that referenced this pull request May 24, 2018
This patch fixes a bug introduced by my latest PR (see #23). We expect a
secrets.yml file.
jmaupetit added a commit that referenced this pull request May 24, 2018
This patch fixes a bug introduced by my latest PR (see #23). We expect a
secrets.yml file.
jmaupetit added a commit that referenced this pull request May 24, 2018
This patch fixes a bug introduced by my latest PR (see #23). We expect a
secrets.yml file.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants