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

Release prep v7.0.0 #2201

Merged
merged 1 commit into from
Oct 11, 2021
Merged

Release prep v7.0.0 #2201

merged 1 commit into from
Oct 11, 2021

Conversation

github-actions[bot]
Copy link

@github-actions github-actions bot commented Oct 11, 2021

Automated release-prep through pdk-templates from commit 650e5f6.
Please verify before merging:

@github-actions github-actions bot requested a review from a team as a code owner October 11, 2021 13:57
Copy link
Member

@david22swan david22swan left a comment

Choose a reason for hiding this comment

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

LGTM

@david22swan david22swan merged commit 090393d into main Oct 11, 2021
@david22swan david22swan deleted the release-prep branch October 11, 2021 14:46
@ekohl
Copy link
Collaborator

ekohl commented Oct 11, 2021

Can I object to these major version releases without wider approval and merging within a few hours? This is poor release management. For example, this code here has been throwing warnings that 7.0.0 would change the format:

# IAC-1186: A number of configuration and log file names are generated using the $name parameter. It is possible for
# the $name parameter to contain spaces, which could then be transferred to the log / config filenames. Although
# POSIX compliant, this can be cumbersome.
#
# It seems more appropriate to use the $servername parameter to derive default log / config filenames from. We should
# also perform some sanitiation on the $servername parameter to strip spaces from it, as it defaults to the value of
# $name, should $servername NOT be defined.
#
# Because a single hostname may be use by multiple virtual hosts listening on different ports, the $port paramter can
# optionaly be used to avoid duplicate resources.
#
# We will retain the default behaviour for filenames but allow the use of a sanitized version of $servername to be
# used, using the new $use_servername_for_filenames and $use_port_for_filenames parameters.
#
# This will default to false until the next major release (v7.0.0), at which point, we will default this to true and
# warn about it's imminent deprecation in the subsequent major release (v8.0.0)
#
# In v8.0.0, we will deprecate the $use_servername_for_filenames and $use_port_for_filenames parameters altogether
# and use the sanitized value of $servername for default log / config filenames.
$filename = $use_servername_for_filenames ? {
true => $use_port_for_filenames ? {
true => regsubst("${normalized_servername}-${port}", ' ', '_', 'G'),
false => regsubst($normalized_servername, ' ', '_', 'G'),
},
false => $name,
}
if ! $use_servername_for_filenames and $name != $normalized_servername {
$use_servername_for_filenames_warn_msg = '
It is possible for the $name parameter to be defined with spaces in it. Although supported on POSIX systems, this
can lead to cumbersome file names. The $servername attribute has stricter conditions from Apache (i.e. no spaces)
When $use_servername_for_filenames = true, the $servername parameter, sanitized, is used to construct log and config
file names.
From version v7.0.0 of the puppetlabs-apache module, this parameter will default to true. From version v8.0.0 of the
module, the $use_servername_for_filenames will be removed and log/config file names will be derived from the
sanitized $servername parameter when not explicitly defined.'
warning($use_servername_for_filenames_warn_msg)
} elsif ! $use_port_for_filenames {
$use_port_for_filenames_warn_msg = '
It is possible for multiple virtual hosts to be configured using the same $servername but a different port. When
using $use_servername_for_filenames, this can lead to duplicate resource declarations.
When $use_port_for_filenames = true, the $servername and $port parameters, sanitized, are used to construct log and
config file names.
From version v7.0.0 of the puppetlabs-apache module, this parameter will default to true. From version v8.0.0 of the
module, the $use_port_for_filenames will be removed and log/config file names will be derived from the
sanitized $servername parameter when not explicitly defined.'
warning($use_port_for_filenames_warn_msg)
}

However, that now hasn't happened. For users who upgrade to 7.0.0 this will be extremely confusing.

Major releases should be treated with much more care.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants