-
Notifications
You must be signed in to change notification settings - Fork 105
feat: Add build-time policy to disable self-update in packaged builds #675
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
Open
melund
wants to merge
4
commits into
microsoft:main
Choose a base branch
from
melund:update-policy
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| """Build-time policy for APM self-update behavior. | ||
|
|
||
| Package maintainers can patch this module during build to disable self-update | ||
| and show users a package-manager-specific update command. | ||
| """ | ||
|
|
||
| # Default guidance when self-update is disabled. | ||
| DEFAULT_SELF_UPDATE_DISABLED_MESSAGE = ( | ||
| "Self-update is disabled for this APM distribution. " | ||
| "Update APM using your package manager." | ||
| ) | ||
|
|
||
| # Build-time policy values. | ||
| # | ||
| # Packagers can patch these constants during build, for example: | ||
| # - SELF_UPDATE_ENABLED = False | ||
| # - SELF_UPDATE_DISABLED_MESSAGE = "Update with: pixi update apm-cli" | ||
| SELF_UPDATE_ENABLED = True | ||
| SELF_UPDATE_DISABLED_MESSAGE = DEFAULT_SELF_UPDATE_DISABLED_MESSAGE | ||
|
|
||
|
|
||
| def _is_printable_ascii(value: str) -> bool: | ||
| """Return True when value contains only printable ASCII characters.""" | ||
| return all(" " <= char <= "~" for char in value) | ||
|
|
||
|
|
||
| def is_self_update_enabled() -> bool: | ||
| """Return True when this build allows self-update.""" | ||
| return SELF_UPDATE_ENABLED is True | ||
|
|
||
|
|
||
| def get_self_update_disabled_message() -> str: | ||
| """Return the guidance message shown when self-update is disabled.""" | ||
| if SELF_UPDATE_DISABLED_MESSAGE is None: | ||
| return DEFAULT_SELF_UPDATE_DISABLED_MESSAGE | ||
|
|
||
| message = str(SELF_UPDATE_DISABLED_MESSAGE).strip() | ||
| if not message: | ||
| return DEFAULT_SELF_UPDATE_DISABLED_MESSAGE | ||
|
|
||
| if not _is_printable_ascii(message): | ||
| return DEFAULT_SELF_UPDATE_DISABLED_MESSAGE | ||
|
|
||
| return message | ||
|
|
||
|
melund marked this conversation as resolved.
|
||
|
|
||
| def get_update_hint_message() -> str: | ||
| """Return the update hint used in startup notifications.""" | ||
| if is_self_update_enabled(): | ||
| return "Run apm update to upgrade" | ||
| return get_self_update_disabled_message() | ||
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.