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

Postfix: rename "smtps" to "submissions" #3235

Merged
merged 3 commits into from May 10, 2023

Conversation

georglauterbach
Copy link
Member

@georglauterbach georglauterbach commented Apr 8, 2023

Description

@polarathene I am unsure whether we need to change even more. Please tell me if I forgot about something crucial.

Type of change

  • Update (non-breaking change that does improve existing functionality)
  • This change requires a documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (README.md or the documentation under docs/)
  • If necessary I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@georglauterbach georglauterbach added service/postfix meta/feature freeze On hold due to upcoming release process area/configuration (file) kind/update Update an existing feature, configuration file or the documentation labels Apr 8, 2023
@georglauterbach georglauterbach added this to the v12.1.0 milestone Apr 8, 2023
@georglauterbach georglauterbach self-assigned this Apr 8, 2023
@polarathene
Copy link
Member

Please tell me if I forgot about something crucial.

Nope, just replacing smtps for submissions in the project files should do it AFAIK.

We may want to add a minor test that greps 465 in /etc/services of the container to confirm it is assigned submissions. If the base image changes, that sometimes won't be the case (surprisingly with Fedora), so it'd be good to catch that instead of potential confusion troubleshooting it down to that issue 😅


I did want to get this into v12, but forgot about it. Probably should be considered a breaking change 🤷‍♂️

v13 release after v12.1 maybe?

@georglauterbach
Copy link
Member Author

We may want to add a minor test that greps 465 in /etc/services of the container to confirm it is assigned submissions. If the base image changes, that sometimes won't be the case (surprisingly with Fedora), so it'd be good to catch that instead of potential confusion troubleshooting it down to that issue 😅

👍🏼

I did want to get this into v12, but forgot about it. Probably should be considered a breaking change 🤷‍♂️

v13 release after v12.1 maybe?

I thought this was fine for v12.1.0, because I see no reason that this is a breaking change. Why would you consider this a breaking change?

@polarathene
Copy link
Member

polarathene commented Apr 9, 2023

Why would you consider this a breaking change?

If someone depends on smtps being configured here?:

smtps inet n - n - - smtpd
-o syslog_name=postfix/smtps

Some issues that show this could happen:

Since we provide ways to target configuration for smtps/submissions, and it's used as the syslog name for monitoring logs, I wouldn't be surprised if some users find it a breaking change. @wernerfred usually views this sort of change as breaking as well.


For reference, a comment motivating this smtps => submissions change (since none was provided in the PR description): #3170 (comment)

Squeeze the change into v12 if you'd like? It shouldn't cause any surprises beyond concerns mentioned above, so you can probably avoid further delaying testing / freeze. If you do add it, then it should be part of the notable changes list in the changelog.

@casperklein
Copy link
Member

Some issues that show this could happen:

Good points. If there isn't a huge benefit, but possible (future) problems with stuff like fail2ban expecting smtps, I think it's not worth and we shouldn't change it.

@polarathene
Copy link
Member

I think it's not worth and we shouldn't change it.

It's fine for introducing as a breaking change. Users can raise actual bug reports to surface the problems.

Like I said, I am not sure if fail2ban monitoring smtps was relevant, just an example that came to mind. I looked through git blame and realized that the regex still covers submissions, even though it was added back in 2016. So no issue there with this change.

Users may still have their own config / scripts or other tools that are more explicitly expecting smtps, which is my main point of respecting semver by only applying the change for a major release.

@georglauterbach
Copy link
Member Author

I had a glance at our F2B config as well, and it is using submissions, not smtps, as @polarathene said.

I am fine with waiting for the next major with this. It will probably not even take too long for v13.0.0 to come out, due to other changes I have in mind.

@georglauterbach georglauterbach modified the milestones: v12.1.0, v13.0.0 Apr 9, 2023
@georglauterbach georglauterbach marked this pull request as draft April 10, 2023 09:02
@georglauterbach georglauterbach removed the meta/feature freeze On hold due to upcoming release process label Apr 10, 2023
@georglauterbach georglauterbach marked this pull request as ready for review April 28, 2023 07:46
@georglauterbach georglauterbach added the meta/feature freeze On hold due to upcoming release process label Apr 28, 2023
@georglauterbach
Copy link
Member Author

INFO: Marked this with meta/feature-freeze now to indicate this PR is not to be merged before v12.1.0 is released.

@georglauterbach georglauterbach removed the meta/feature freeze On hold due to upcoming release process label May 10, 2023
@github-actions
Copy link
Contributor

Documentation preview for this PR is ready! 🎉

Built with commit: c24b24b

@georglauterbach georglauterbach merged commit 595ff03 into master May 10, 2023
9 checks passed
@georglauterbach georglauterbach deleted the rename-smtps-to-submissions branch May 10, 2023 09:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/configuration (file) kind/update Update an existing feature, configuration file or the documentation service/postfix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants