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

Add windir to the default list of pass_env variables on Windows #3303

Merged
merged 1 commit into from
Jul 1, 2024

Conversation

kurtmckee
Copy link
Contributor

@kurtmckee kurtmckee commented Jul 1, 2024

This PR adds windir to the default list of Windows pass_env environment variables.

windir is a system environment variable that has existed since Windows 95. Like TMP and USERPROFILE, it is assumed to exist and no software documents that it should be set. It is often difficult to figure out that crashes and errors are caused by a missing windir environment variable.

This change allows Windows software that relies on windir to work out-of-the-box.

Note

The canonical spelling of windir is lowercase. This PR uses an uppercase variant based on PR feedback.

Fixes #3302

  • ran the linter to address style issues (tox -e fix)
  • wrote descriptive pull request text
  • ensured there are test(s) validating the fix
  • added news fragment in docs/changelog folder
  • updated/extended the documentation

Copy link
Member

@gaborbernat gaborbernat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tests/session/cmd/test_show_config.py Outdated Show resolved Hide resolved
@kurtmckee kurtmckee force-pushed the add-windir-to-default-pass_env branch from 7aff1dc to 8aa94b1 Compare July 1, 2024 15:40
Copy link
Member

@gaborbernat gaborbernat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

@gaborbernat gaborbernat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The CI is failing...

@kurtmckee
Copy link
Contributor Author

Oof, this is harder when I'm not in front of my Windows PC to test locally. I'll update this again!

@kurtmckee kurtmckee force-pushed the add-windir-to-default-pass_env branch from 8aa94b1 to b10b87d Compare July 1, 2024 16:07
@kurtmckee
Copy link
Contributor Author

It looks like the docs environment is failing on Windows due to a timeout with GitHub, but if I'm reading that incorrectly and it's related to this PR please let me know. 👍

Copy link
Member

@gaborbernat gaborbernat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gaborbernat gaborbernat merged commit 264d44f into tox-dev:main Jul 1, 2024
24 of 25 checks passed
@kurtmckee kurtmckee deleted the add-windir-to-default-pass_env branch July 1, 2024 16:30
naa0yama referenced this pull request in naa0yama/PythonBoilerplate Jul 11, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [tox](https://togithub.com/tox-dev/tox)
([changelog](https://tox.wiki/en/latest/changelog.html)) | `~4.15.0` ->
`~4.16.0` |
[![age](https://developer.mend.io/api/mc/badges/age/pypi/tox/4.16.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/tox/4.16.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/tox/4.15.1/4.16.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/tox/4.15.1/4.16.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>tox-dev/tox (tox)</summary>

### [`v4.16.0`](https://togithub.com/tox-dev/tox/releases/tag/4.16.0)

[Compare
Source](https://togithub.com/tox-dev/tox/compare/4.15.1...4.16.0)

<!-- Release notes generated using configuration in .github/release.yml
at 4.16.0 -->

#### What's Changed

- Fix two small documentation issues by
[@&#8203;srenfo](https://togithub.com/srenfo) in
[https://github.com/tox-dev/tox/pull/3297](https://togithub.com/tox-dev/tox/pull/3297)
- Fix tests after new setuptools by
[@&#8203;gaborbernat](https://togithub.com/gaborbernat) in
[https://github.com/tox-dev/tox/pull/3299](https://togithub.com/tox-dev/tox/pull/3299)
- Add `windir` to the default list of `pass_env` variables on Windows by
[@&#8203;kurtmckee](https://togithub.com/kurtmckee) in
[https://github.com/tox-dev/tox/pull/3303](https://togithub.com/tox-dev/tox/pull/3303)

#### New Contributors

- [@&#8203;srenfo](https://togithub.com/srenfo) made their first
contribution in
[https://github.com/tox-dev/tox/pull/3297](https://togithub.com/tox-dev/tox/pull/3297)

**Full Changelog**:
tox-dev/tox@4.15.1...4.16.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/naa0yama/PythonBoilerplate).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MjEuOSIsInVwZGF0ZWRJblZlciI6IjM3LjQyMS45IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJkYXRhc291cmNlOnB5cGkiLCJkZXBUeXBlOmRldiIsIm1hbmFnZXI6cG9ldHJ5IiwicmVub3ZhdGUiLCJ1cGRhdGUtbWlub3IiLCJ2ZXJzaW9uaW5nOnBvZXRyeSJdfQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
hofbi referenced this pull request in luminartech/dev-tools Aug 9, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [tox](https://togithub.com/tox-dev/tox)
([changelog](https://tox.wiki/en/latest/changelog.html)) | `==4.15.1` ->
`==4.17.1` |
[![age](https://developer.mend.io/api/mc/badges/age/pypi/tox/4.17.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/tox/4.17.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/tox/4.15.1/4.17.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/tox/4.15.1/4.17.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>tox-dev/tox (tox)</summary>

### [`v4.17.1`](https://togithub.com/tox-dev/tox/releases/tag/4.17.1)

[Compare
Source](https://togithub.com/tox-dev/tox/compare/4.17.0...4.17.1)

<!-- Release notes generated using configuration in .github/release.yml
at 4.17.1 -->

#### What's Changed

- Restore limited `<major>.<minor>` environment name support by
[@&#8203;gaborbernat](https://togithub.com/gaborbernat) in
[https://github.com/tox-dev/tox/pull/3319](https://togithub.com/tox-dev/tox/pull/3319)
- fix(tox_env.python): do not process absolute paths to interpreter as
PythonSpec by [@&#8203;paveldikov](https://togithub.com/paveldikov) in
[https://github.com/tox-dev/tox/pull/3311](https://togithub.com/tox-dev/tox/pull/3311)

#### New Contributors

- [@&#8203;paveldikov](https://togithub.com/paveldikov) made their first
contribution in
[https://github.com/tox-dev/tox/pull/3311](https://togithub.com/tox-dev/tox/pull/3311)

**Full Changelog**:
tox-dev/tox@4.17.0...4.17.1

### [`v4.17.0`](https://togithub.com/tox-dev/tox/releases/tag/4.17.0)

[Compare
Source](https://togithub.com/tox-dev/tox/compare/4.16.0...4.17.0)

<!-- Release notes generated using configuration in .github/release.yml
at 4.17.0 -->

#### What's Changed

- Fix user guide system overview so nodes don't overlap. by
[@&#8203;Tom01098](https://togithub.com/Tom01098) in
[https://github.com/tox-dev/tox/pull/3307](https://togithub.com/tox-dev/tox/pull/3307)
- Table with list of default env vars per OS by
[@&#8203;seyidaniels](https://togithub.com/seyidaniels) in
[https://github.com/tox-dev/tox/pull/3291](https://togithub.com/tox-dev/tox/pull/3291)
- Add GraalPy and test both GraalPy and Jython env identifiers by
[@&#8203;timfel](https://togithub.com/timfel) in
[https://github.com/tox-dev/tox/pull/3312](https://togithub.com/tox-dev/tox/pull/3312)
- Add on platform constat to core by
[@&#8203;gaborbernat](https://togithub.com/gaborbernat) in
[https://github.com/tox-dev/tox/pull/3315](https://togithub.com/tox-dev/tox/pull/3315)

#### New Contributors

- [@&#8203;Tom01098](https://togithub.com/Tom01098) made their first
contribution in
[https://github.com/tox-dev/tox/pull/3307](https://togithub.com/tox-dev/tox/pull/3307)
- [@&#8203;timfel](https://togithub.com/timfel) made their first
contribution in
[https://github.com/tox-dev/tox/pull/3312](https://togithub.com/tox-dev/tox/pull/3312)

**Full Changelog**:
tox-dev/tox@4.16.0...4.17.0

### [`v4.16.0`](https://togithub.com/tox-dev/tox/releases/tag/4.16.0)

[Compare
Source](https://togithub.com/tox-dev/tox/compare/4.15.1...4.16.0)

<!-- Release notes generated using configuration in .github/release.yml
at 4.16.0 -->

#### What's Changed

- Fix two small documentation issues by
[@&#8203;srenfo](https://togithub.com/srenfo) in
[https://github.com/tox-dev/tox/pull/3297](https://togithub.com/tox-dev/tox/pull/3297)
- Fix tests after new setuptools by
[@&#8203;gaborbernat](https://togithub.com/gaborbernat) in
[https://github.com/tox-dev/tox/pull/3299](https://togithub.com/tox-dev/tox/pull/3299)
- Add `windir` to the default list of `pass_env` variables on Windows by
[@&#8203;kurtmckee](https://togithub.com/kurtmckee) in
[https://github.com/tox-dev/tox/pull/3303](https://togithub.com/tox-dev/tox/pull/3303)

#### New Contributors

- [@&#8203;srenfo](https://togithub.com/srenfo) made their first
contribution in
[https://github.com/tox-dev/tox/pull/3297](https://togithub.com/tox-dev/tox/pull/3297)

**Full Changelog**:
tox-dev/tox@4.15.1...4.16.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "before 4am on the first day of the
month" (UTC), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR was generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View the
[repository job
log](https://developer.mend.io/github/luminartech/dev-tools).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC4yMC4xIiwidXBkYXRlZEluVmVyIjoiMzguMjAuMSIsInRhcmdldEJyYW5jaCI6Im1hc3RlciIsImxhYmVscyI6W119-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Include windir by default in pass_env
2 participants