fix: handle SIGTERM in serve command to clean up temp site_dir#4162
Open
Mubashir78 wants to merge 1 commit into
Open
fix: handle SIGTERM in serve command to clean up temp site_dir#4162Mubashir78 wants to merge 1 commit into
Mubashir78 wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fix #3905
Problem
When
mkdocs servereceives SIGTERM (e.g., when a Docker container is stopped), the process is killed immediately without running cleanup code. The temporarysite_dircreated in/tmpis never deleted, causing directories to accumulate.Only
KeyboardInterrupt(SIGINT / Ctrl+C) was handled, which triggered the cleanup path.Fix
Register a SIGTERM signal handler that raises
KeyboardInterrupt. This triggers the existing cleanup path in theexcept KeyboardInterrupt/finallyblocks, which callsserver.shutdown()andshutil.rmtree(site_dir).After the first SIGTERM is caught, the handler is restored to
SIG_DFLso a second SIGTERM during cleanup will force-kill the process.Verification
signal.signal(signal.SIGTERM, ...)is registered with the_sigterm_handlerthat raisesKeyboardInterrupt