Skip to content

Document environment variable precedence - #4364

Open
happz wants to merge 12 commits into
mainfrom
document-envvar-precedence
Open

happz wants to merge 12 commits into
mainfrom
document-envvar-precedence

Conversation

@happz

@happz happz commented Nov 25, 2025

Copy link
Copy Markdown
Contributor

Related to #4241

See #4241 for TODO items and tracking.

See https://tmt--4364.org.readthedocs.build/en/4364/environment.html for the preview.

Pull Request Checklist

  • implement the feature
  • write the documentation
  • update the specification
  • include a release note

@happz happz added documentation Improvements or additions to documentation area | environment Environment variables handling labels Nov 25, 2025
@happz happz added this to planning Nov 25, 2025
@github-project-automation github-project-automation Bot moved this to backlog in planning Nov 25, 2025
@happz happz moved this from backlog to implement in planning Nov 25, 2025
@happz

happz commented Nov 25, 2025

Copy link
Copy Markdown
Contributor Author

Ok, kicking of with a summary and a couple of notes and TODO items while my memory is reasonably fresh.

See https://tmt--4364.org.readthedocs.build/en/4364/environment.html for the preview.

Ignore the location of the document, I just needed to hook it somewhere.

@psss psss linked an issue Nov 26, 2025 that may be closed by this pull request
25 tasks
@psss

psss commented Nov 26, 2025

Copy link
Copy Markdown
Member

Synced priority with the issue and proposed for the next sprint as agreed on the hacking session.

@LecrisUT LecrisUT self-assigned this Nov 28, 2025
@happz happz moved this from implement to backlog in planning Dec 2, 2025
@psss psss self-assigned this Dec 4, 2025
@psss psss added this to the 1.64 milestone Dec 4, 2025
Comment thread docs/environment.rst Outdated
Comment thread docs/environment.rst Outdated
Comment thread docs/environment.rst Outdated
Comment thread docs/environment.rst
Comment thread docs/environment.rst Outdated
Comment thread docs/environment.rst Outdated
@happz happz removed this from the 1.64 milestone Dec 9, 2025
@happz
happz force-pushed the document-envvar-precedence branch from c1f008e to cf4c675 Compare December 9, 2025 12:15
@happz
happz force-pushed the document-envvar-precedence branch from cda563a to e6331d1 Compare June 5, 2026 00:01
Comment thread docs/conf.py Outdated
@happz
happz force-pushed the document-envvar-precedence branch from 21dc872 to f448eac Compare June 8, 2026 08:09
@happz
happz force-pushed the document-envvar-precedence branch from f448eac to 8324b82 Compare August 4, 2026 11:47
@happz
happz changed the base branch from main to environment-builder-with-ordering August 4, 2026 11:47
@happz happz moved this from backlog to review in planning Aug 4, 2026
@happz
happz marked this pull request as ready for review August 4, 2026 12:58
Comment thread docs/environment.rst Outdated
@happz happz mentioned this pull request Aug 11, 2026
4 tasks
@happz
happz force-pushed the document-envvar-precedence branch from 8324b82 to 15df292 Compare August 12, 2026 20:25
@therazix
therazix force-pushed the document-envvar-precedence branch from ca5868d to eb749a4 Compare August 31, 2026 13:34
@happz
happz force-pushed the document-envvar-precedence branch from eb749a4 to f594fcf Compare September 1, 2026 07:34
@happz
happz force-pushed the document-envvar-precedence branch from f594fcf to 3ff09df Compare September 7, 2026 19:59
@happz
happz force-pushed the document-envvar-precedence branch from 3ff09df to cddc08c Compare September 11, 2026 14:11

@LecrisUT LecrisUT left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Overall LGTM, only confusion is with the "User"

Comment thread docs/environment.rst
Comment on lines +18 to +19
1. User-provided test environment
:::::::::::::::::::::::::::::::::

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Is there a different wording we could use here. "User-provided" is a bit loaded and overlaps with the "command line" part. For me the user here is more like the executioner, not the author of the fmf file, so probably that's why it gets more loaded for me.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Not having any idea of my own, I'm open to suggestions.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hmm, some possibilities: "static", "fmf file defined", "author defined" (would need glossary), just "test environment"?

Also for this one in particular it could use a quick note on adjust-test? Or have somewhere to explicitly mention where the fmf file evaluation (and discover) fit in here.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I use "user" as a term in contrast to "variables added and owned by tmt", with no distiction between "user who wrote fmf files" and "user who runs tmt run". I believe we don't have dedicated labels for these two roles.

@LecrisUT LecrisUT removed their assignment Sep 11, 2026
@happz
happz force-pushed the document-envvar-precedence branch from cddc08c to 5b4634a Compare September 13, 2026 14:47
Base automatically changed from environment-builder-with-ordering to main September 13, 2026 18:47
@happz
happz force-pushed the document-envvar-precedence branch from 5b4634a to 3cb51ec Compare September 13, 2026 18:47
@happz
happz force-pushed the document-envvar-precedence branch from 3cb51ec to 5685d99 Compare September 14, 2026 09:15
@happz happz removed the status | blocked The merging of PR is blocked on some other issue label Sep 14, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area | environment Environment variables handling documentation Improvements or additions to documentation status | blocking other work An important pull request, blocking other pull requests or issues

Projects

Status: review

Development

Successfully merging this pull request may close these issues.

Document the order of precedence of environment variable sources

3 participants