feature: add `update-environment` input by mayeut · Pull Request #411 · actions/setup-python · GitHub

Description:
This option allows to specify if the action shall update environment variables (default) or not.
This allows to use the setup-python action in a composite action without side effect (except downloading/installing python if version is missing).

Related issue:
fix #410

Check list:

Mark if documentation changes are required.
Mark if tests were added or updated to cover the changes.

This required to be bumped to >= 1.3.0 to get getBooleanInput support. I bumped to the same version as what's being proposed in #406

e2e-cache / Test poetry (Python pypy-3.7-v7.x, windows-latest) failure has nothing to do with this PR.

I'd like to explore other solutions besides adding complexity to the action.

Can you just add steps to the composite action? For example:

# Save the environment
set > env.sh

# Restore the environment
source env.sh

@brcrista,
there's no way to revert a core.addPath or a core.exportVariable

For exportVariable:
If they were already set, then the ones with exportVariable could be overriden back to their original values.
If they were not set, it's impossible to unset them: https://stackoverflow.com/questions/70137245/how-to-remove-an-environment-variable-on-github-actions

For addPath, it's values are always prepended to the "current" PATH, c.f. actions/toolkit#655

Hi @mayeut, I have some concerns about this feature. In order to use python that is installed by action without $PATH updating you should use exact paths to the installed python in a composite action. If there are any other tools in composite action which use python implicitly, then these tools will not use the version you expect. This can lead to confusion about which python version is used in some command or tool.

From my point of view an installation of python without adding to PATH may create more complications than solve problems.

In order to use python that is installed by action without $PATH updating you should use exact paths to the installed python in a composite action. If there are any other tools in composite action which use python implicitly, then these tools will not use the version you expect. This can lead to confusion about which python version is used in some command or tool.
From my point of view an installation of python without adding to PATH may create more complications than solve problems.

@vsafonkin,

This is an opt-in feature. It won't change a thing for existing users. If they choose to opt-in, they shall know the implications.
Furthermore, you can easily test your own action with a GHA workflow to check if it's working as expected or not but you can't possibly test how you'll break hundreds of downstream workflows using your action if you mess up the environment. I'd rather just get ahead of this most likely event by not messing with the environment in the first place.
Last time setup-python introduced a change in environment variables, it did create some issues (#159). I'd rather avoid that.

As said in an earlier comment, it's just impossible to restore the environment as it was before running setup-python. Even if it were, I feel that it would be better solved by adding a bit of complexity in this action, centralized, rather than incurring workarounds for downstream users.

@mayeut, ok, I see. Since the AzDev UsePython task has a similar input addToPath I think it makes sense to add this feature to the action.

I'll defer to @vsafonkin on this

Suggested change

      
              no-environment-update:
          
                description: 'Set this option if you want the action not to update environment variables.'
          
                default: false
          
              update-environment:
          
                description: 'Set this option if you want the action to update environment variables.'
          
                default: true

Putting boolean inputs in positive terms is usually easier for people to understand.

done

This option allows to specify if the action shall update environment variables (default) or not. This allows to use the setup-python action in a composite action without side effect (except downloading/installing python if version is missing).

disallow actions/setup-python from changing environment variables; see: actions/runner#781 actions/setup-python#411

This option allows to specify if the action shall update environment variables (default) or not. This allows to use the setup-python action in a composite action without side effect (except downloading/installing python if version is missing).

mayeut requested a review from a team May 26, 2022 14:20

mayeut commented May 26, 2022

View reviewed changes

mayeut force-pushed the no-envvar branch from aacdfa2 to e1a07fc Compare May 26, 2022 14:35

mayeut mentioned this pull request May 26, 2022

feature: add an option not to add/update environment variables #410

Closed

mayeut force-pushed the no-envvar branch from e1a07fc to df47808 Compare May 26, 2022 14:45

brcrista suggested changes May 26, 2022

View reviewed changes

mayeut mentioned this pull request May 26, 2022

action: use the most recent python from tool cache to run the GitHub Action pypa/cibuildwheel#1114

Merged

mayeut force-pushed the no-envvar branch from df47808 to 0c31abe Compare May 31, 2022 22:43

mayeut force-pushed the no-envvar branch from 0c31abe to 0e67079 Compare June 4, 2022 10:09

mayeut force-pushed the no-envvar branch 4 times, most recently from 2d144fe to 48426e9 Compare June 13, 2022 22:40

mayeut force-pushed the no-envvar branch from 48426e9 to 85e6b2f Compare June 16, 2022 05:48

henryiii mentioned this pull request Jun 16, 2022

fix overwriting wheel on macos pypa/cibuildwheel#1129

Merged

brcrista reviewed Jun 23, 2022

View reviewed changes

brcrista requested review from brcrista and vsafonkin June 23, 2022 17:27

brcrista reviewed Jun 23, 2022

View reviewed changes

mayeut force-pushed the no-envvar branch from 85e6b2f to 0f3b8dc Compare June 23, 2022 19:46

feature: add update-environment input

c7bc360

This option allows to specify if the action shall update environment variables (default) or not. This allows to use the setup-python action in a composite action without side effect (except downloading/installing python if version is missing).

mayeut force-pushed the no-envvar branch from 0f3b8dc to c7bc360 Compare June 23, 2022 19:47

mayeut changed the title feature: add no-environment-update input feature: add update-environment input Jun 23, 2022

dmitry-shibanov approved these changes Jun 24, 2022

View reviewed changes

marko-zivic-93 approved these changes Jun 24, 2022

View reviewed changes

IvanZosimov approved these changes Jun 24, 2022

View reviewed changes

brcrista approved these changes Jun 28, 2022

View reviewed changes

vsafonkin approved these changes Jun 29, 2022

View reviewed changes

brcrista merged commit 00a5248 into actions:main Jun 29, 2022

mayeut deleted the no-envvar branch June 29, 2022 19:50

tomkinsc added a commit to broadinstitute/viral-phylo that referenced this pull request Mar 20, 2024

disallow actions/setup-python from changing environment variables

05ab90f

disallow actions/setup-python from changing environment variables; see: actions/runner#781 actions/setup-python#411

gowridurgad mentioned this pull request Apr 7, 2025

Fails to run on self hosted Windows runner if pip is not in PATH #1050

Open

5 tasks

                 "dependencies": {
                   "@actions/cache": "^2.0.2",
-                  "@actions/core": "^1.2.3",
+                  "@actions/core": "^1.7.0",

feature: add `update-environment` input by mayeut · Pull Request #411 · actions/setup-python · GitHub

Uh oh!

feature: add update-environment input - #411

feature: add update-environment input#411
brcrista merged 1 commit into
actions:mainfrom
mayeut:no-envvar

mayeut commented May 26, 2022

Uh oh!

mayeut May 26, 2022

Uh oh!

mayeut commented May 26, 2022

Uh oh!

brcrista left a comment

Uh oh!

mayeut commented May 26, 2022

Uh oh!

vsafonkin commented Jun 1, 2022 •
edited
Loading

Uh oh!

Uh oh!

mayeut commented Jun 4, 2022

Uh oh!

vsafonkin commented Jun 6, 2022

Uh oh!

brcrista left a comment

Uh oh!

brcrista Jun 23, 2022

Uh oh!

mayeut Jun 23, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

feature: add `update-environment` input by mayeut · Pull Request #411 · actions/setup-python · GitHub

Uh oh!

feature: add update-environment input - #411

feature: add update-environment input#411brcrista merged 1 commit intoactions:mainactions/setup-python:mainfrom mayeut:no-envvarmayeut/setup-python:no-envvarCopy head branch name to clipboard

Conversation

mayeut commented May 26, 2022

Uh oh!

mayeut May 26, 2022

Choose a reason for hiding this comment

Uh oh!

mayeut commented May 26, 2022

Uh oh!

brcrista left a comment

Choose a reason for hiding this comment

Uh oh!

mayeut commented May 26, 2022

Uh oh!

vsafonkin commented Jun 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mayeut commented Jun 4, 2022

Uh oh!

vsafonkin commented Jun 6, 2022

Uh oh!

brcrista left a comment

Choose a reason for hiding this comment

Uh oh!

brcrista Jun 23, 2022

Choose a reason for hiding this comment

Uh oh!

mayeut Jun 23, 2022

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

feature: add update-environment input#411
brcrista merged 1 commit into
actions:mainfrom
mayeut:no-envvar

vsafonkin commented Jun 1, 2022 •
edited
Loading