Core: Make BLENDER_SYSTEM_SCRIPTS always add paths #122689

Brecht Van Lommel · 2024-06-03T21:07:53+02:00

Brecht Van Lommel commented

2024-06-03 21:07:53 +02:00

Originally this would replace scripts that come bundled with Blender,
but it's unclear how this is useful.

Searching for this online mainly leads to people asking how they can
use it to add scripts. For example in a studio environment you might
want to deploy add-ons and startup scripts for all users.

Even if you wanted to use it for replacement though, it's not really
doing that and inconsistent for different types of scripts:

startup: ignored
modules: replaces bundled scripts
presets: adds to bundled scripts
addons (in 4.1): ignored
addons_core (in 4.2): ignored
startup/bl_app_templates_system: replaces bundled scripts

This change makes it add scripts from this path for all. This is a
breaking change, though arguably this feature is just broken to begin
with and not used much in practice because of that.

The alternative would be add a new set of environment variables to
avoid breaking existing behavior. But that also means keeping around the
broken behavior or fixing it in another way.

Supporting multiple paths may be used too, but for now just support
a single one as doing this for all BLENDER_SYSTEM variables is
non-trivial. The main use case for that would be add-ons anyway, and
those will mainly be handled through upcoming BLENDER_SYSTEM_EXTENSIONS
instead.

Ref #122512

Originally this would replace scripts that come bundled with Blender, but it's unclear how this is useful. Searching for this online mainly leads to people asking how they can use it to add scripts. For example in a studio environment you might want to deploy add-ons and startup scripts for all users. Even if you wanted to use it for replacement though, it's not really doing that and inconsistent for different types of scripts: * startup: ignored * modules: replaces bundled scripts * presets: adds to bundled scripts * addons (in 4.1): ignored * addons_core (in 4.2): ignored * startup/bl_app_templates_system: replaces bundled scripts This change makes it add scripts from this path for all. This is a breaking change, though arguably this feature is just broken to begin with and not used much in practice because of that. The alternative would be add a new set of environment variables to avoid breaking existing behavior. But that also means keeping around the broken behavior or fixing it in another way. Supporting multiple paths may be used too, but for now just support a single one as doing this for all BLENDER_SYSTEM variables is non-trivial. The main use case for that would be add-ons anyway, and those will mainly be handled through upcoming BLENDER_SYSTEM_EXTENSIONS instead. Ref #122512

Brecht Van Lommel requested review from Campbell Barton 2024-06-03 21:08:38 +02:00

Brecht Van Lommel requested review from Bastien Montagne 2024-06-03 21:08:38 +02:00

Brecht Van Lommel commented

2024-06-03 21:36:50 +02:00

This is something that has been bothering me for a while, and now that a bunch of stuff is changing because of extensions it seemed like a good moment to fix it.

Maybe we'll also need a BLENDER_SYSTEM_EXTENSIONS that behaves the same way, if that will become the preferred mechanism. But it's not clear to me yet if and how extension repositories work well with automated deployment, because it seems to require an index to be generated rather than just unzipping some files.

This is something that has been bothering me for a while, and now that a bunch of stuff is changing because of extensions it seemed like a good moment to fix it. Maybe we'll also need a `BLENDER_SYSTEM_EXTENSIONS` that behaves the same way, if that will become the preferred mechanism. But it's not clear to me yet if and how extension repositories work well with automated deployment, because it seems to require an index to be generated rather than just unzipping some files.

Brecht Van Lommel referenced this pull request

2024-06-04 15:23:28 +02:00

Extensions: Deploying add-ons for offline work and automation #122512

Brecht Van Lommel commented

2024-06-04 15:26:12 +02:00

I added a better summary of the state in #122512.

Brecht Van Lommel requested review from Sergey Sharybin 2024-06-05 16:18:30 +02:00

Brecht Van Lommel force-pushed system-scripts from 99d2245cb6 to f668f5facb

2024-06-05 16:28:15 +02:00

Compare

Brecht Van Lommel commented

2024-06-05 16:28:20 +02:00