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

Document existing orbit auto-uninstall behavior (runs if post-install is supplied and fails, not if install fails) #25300

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

iansltx
Copy link
Member

@iansltx iansltx commented Jan 9, 2025

Haven't done full research yet on why this is, but my guess is that if an install fails we don't know at what stage it failed, so running an uninstall script would potentially just break things further. Putting the trigger on post-install means that it's opt-in (we don't populate post-install scripts by default) and we're uninstalling from a relatively known state (the installer didn't error).

I'll get an issue filed tomorrow to make sure that this remains the desired behavior, or if not then when we change this (e.g. when implementing patching flows), but might as well fix docs in the interim to be clear about what we're doing.

… is supplied and fails, not if install fails)

Haven't done full research yet on why this is, but my guess is that if an install fails we don't know at what stage it failed, so running an uninstall script would potentially just break things further. Putting the trigger on post-install means that it's opt-in (we don't populate post-install scripts by default) and we're uninstalling from a relatively known state (the installer didn't error).

I'll get an issue filed tomorrow to make sure that this remains the desired behavior, or if not then when we change this (e.g. when implementing patching flows), but might as well fix docs in the interim to be clear about what we're doing.
@iansltx iansltx added the :improve documentation Involves writing improvements or additions to documentation label Jan 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:improve documentation Involves writing improvements or additions to documentation
Development

Successfully merging this pull request may close these issues.

1 participant