Skip to content

Fix check config message formatting

Sean McGivern requested to merge fix-check-config-message-formatting into master

This fixes two issues in two commits:

  1. The hard line breaks don't work well when values are interpolated, so remove them all for consistency.
  2. The documentation says to not chomp the newline, but we did that in almost all cases.

Before:

Error: UPGRADE FAILED: template: gitlab/templates/NOTES.txt:46:3: executing "gitlab/templates/NOTES.txt" at <include "gitlab.checkConfig" .>: error calling include: template: gitlab/templates/_checkConfig.tpl:40:54: executing "gitlab.checkConfig" at <fail>: error calling fail:
CONFIGURATION CHECKS:
sidekiq: mixed queues
    It appears you've supplied both `queues` and `negateQueues` for the
    pod definition of `invalid-1`. `negateQueues` is not usable if
    `queues` is provided. Please use only one.sidekiq: mixed queues
    It appears you've supplied both `queues` and `negateQueues` for the
    pod definition of `invalid-2`. `negateQueues` is not usable if
    `queues` is provided. Please use only one.

After:

Error: template: gitlab/templates/NOTES.txt:46:3: executing "gitlab/templates/NOTES.txt" at <include "gitlab.checkConfig" .>: error calling include: template: gitlab/templates/_checkConfig.tpl:39:54: executing "gitlab.checkConfig" at <fail>: error calling fail:
CONFIGURATION CHECKS:

sidekiq: mixed queues
    It appears you've supplied both `queues` and `negateQueues` for the pod definition of `invalid-1`. `negateQueues` is not usable if `queues` is provided. Please use only one.
sidekiq: mixed queues
    It appears you've supplied both `queues` and `negateQueues` for the pod definition of `invalid-2`. `negateQueues` is not usable if `queues` is provided. Please use only one.

Closes #1984 (closed).

Edited by Sean McGivern

Merge request reports