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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable configurations by default #300

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

tacerus
Copy link
Contributor

@tacerus tacerus commented Feb 4, 2023

PR progress checklist (to be filled in by reviewers)

  • Changes to documentation are appropriate (or tick if not required)
  • Changes to tests are appropriate (or tick if not required)
  • Reviews completed

What type of PR is this?

Primary type

  • [build] Changes related to the build system
  • [chore] Changes to the build process or auxiliary tools and libraries such as documentation generation
  • [ci] Changes to the continuous integration configuration
  • [feat] A new feature
  • [fix] A bug fix
  • [perf] A code change that improves performance
  • [refactor] A code change that neither fixes a bug nor adds a feature
  • [revert] A change used to revert a previous commit
  • [style] Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)

Secondary type

  • [docs] Documentation changes
  • [test] Adding missing or correcting existing tests

Does this PR introduce a BREAKING CHANGE?

No - whilst the default behavior technically changes, practically the default behavior before this change would print an error message, hence nobody could have been using it so far.

Related issues and/or pull requests

Describe the changes you're proposing

On distributions without separate available/enabled directories it feels unnecessary having to declared enabled: true in every configuration block. I propose "enabling" configurations by default unless specified otherwise, instead of printing an error about enabled missing from the dict.

Pillar / config required to test the proposed changes

nginx:
  servers:
    managed:
      general.conf:
        available_dir: /etc/nginx/conf.d
        config:
        - server_names_hash_bucket_size: 128

Debug log showing how the proposed changes work

Documentation checklist

  • Updated the README (e.g. Available states).
  • Updated pillar.example.

Testing checklist

  • Included in Kitchen (i.e. under state_top).
  • Covered by new/existing tests (e.g. InSpec, Serverspec, etc.).
  • Updated the relevant test pillar.

Additional context

n/a

@tacerus tacerus requested a review from sticky-note as a code owner February 4, 2023 13:48
Don't require `enabled: true` - helps distributions without
separate available/enabled directories and prevents error:
"Rendering SLS 'production:nginx.servers' failed: Jinja variable 'list
object' has no attribute 'enabled'"

Signed-off-by: Georg Pfuetzenreuter <[email protected]>
@tacerus tacerus force-pushed the nginx-extraconf-enabled branch from 3f11d23 to 23df36d Compare February 4, 2023 13:49
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.

1 participant