Skip to content

Rename supervisor-app.conf to dms-services.conf#3908

Merged
casperklein merged 4 commits intodocker-mailserver:masterfrom
casperklein:rename-supervisor-conf
Feb 28, 2024
Merged

Rename supervisor-app.conf to dms-services.conf#3908
casperklein merged 4 commits intodocker-mailserver:masterfrom
casperklein:rename-supervisor-conf

Conversation

@casperklein
Copy link
Copy Markdown
Member

@casperklein casperklein commented Feb 24, 2024

Description

Discussed in #3901

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (non-breaking change that does improve existing functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my 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
  • I have added information about changes made in this PR to CHANGELOG.md

@casperklein casperklein self-assigned this Feb 24, 2024
@casperklein casperklein added this to the v14.0.0 milestone Feb 24, 2024
@casperklein casperklein marked this pull request as ready for review February 28, 2024 15:29
@casperklein
Copy link
Copy Markdown
Member Author

I've added the necessary info to CHANGELOG.md. But personally, I don't consider such changes as breaking. Breaking for me means, a user can't update a default setup from one version to another without making active changes to keep existing functionality. This is not the case here. Every default (supported) setup will just work fine.
Otherwise every (internal) file changes (renaming functions etc), would also considered as breaking, because someone could have scripted something that uses an old function name for example.

@casperklein casperklein merged commit aa94657 into docker-mailserver:master Feb 28, 2024
@casperklein casperklein deleted the rename-supervisor-conf branch February 28, 2024 22:03
@polarathene
Copy link
Copy Markdown
Member

👍


Otherwise every (internal) file changes (renaming functions etc), would also considered as breaking, because someone could have scripted something that uses an old function name for example.

It's only meant to be considered a breaking internal change if we had some public documentation about it? Only appears to be a separate config though:

https://docker-mailserver.github.io/docker-mailserver/latest/faq/#how-to-adjust-settings-with-the-user-patchessh-script

image

I thought we had advice about modifying the supervisord.conf file, but that was done internally for a specialized log ENV we support:

function _early_supervisor_setup() {
SUPERVISOR_LOGLEVEL="${SUPERVISOR_LOGLEVEL:-warn}"
if ! grep -q "loglevel = ${SUPERVISOR_LOGLEVEL}" /etc/supervisor/supervisord.conf; then
case "${SUPERVISOR_LOGLEVEL}" in
( 'critical' | 'error' | 'info' | 'debug' )
sed -i -E \
"s|(loglevel).*|\1 = ${SUPERVISOR_LOGLEVEL}|g" \
/etc/supervisor/supervisord.conf
supervisorctl reload
exit
;;

I thought the config name might have mattered, but also see that it's not used explicitly 😅

; The [include] section can just contain the "files" setting. This setting can list multiple
; files (separated by whitespace or newlines). It can also contain wildcards. The filenames
; are interpreted as relative to this file. Included files *cannot* include files themselves.
[include]
files = /etc/supervisor/conf.d/*.conf

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.

3 participants