Conversation
Add warnings and guidance about data persistence behavior in tmt: - Add warning to TMT_TREE that data written to this directory is not guaranteed to persist between steps - Update TMT_PLAN_DATA description to emphasize it as the recommended location for storing persistent data across steps - Add note to TMT_TEST_DATA clarifying it is test-specific and pointing users to TMT_PLAN_DATA for cross-step data sharing - Expand the prepare step documentation with a warning about TMT_TREE and cross-reference to the step-variables documentation This helps users avoid a common pitfall where data stored in TMT_TREE may or may not persist depending on the provisioner used, leading to inconsistent behavior between local development and CI environments. Assisted-by Claude Code
Summary of ChangesHello @thrix, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the documentation for Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request does a great job of improving the documentation around data persistence in tmt, specifically clarifying the limitations of TMT_TREE and promoting the use of TMT_PLAN_DATA and TMT_TEST_DATA for persistent and test-specific data respectively. The changes are consistent across overview.rst, prepare.fmf, and the new release note. I've added a couple of minor suggestions to make the new warning messages even more concise and readable. Overall, this is a valuable clarification for users.
| Do **not** store persistent data in ``${TMT_TREE}``. There is no | ||
| guarantee that data written to this directory will persist between | ||
| steps. See :ref:`step-variables` for more details. |
There was a problem hiding this comment.
This is a great addition. For better clarity and conciseness, you could rephrase this warning to avoid the repetition of 'persistent data' and 'persist between steps'.
Do **not** store data in ``${TMT_TREE}`` if it needs to persist
between steps, as there is no guarantee its contents will be
preserved. See :ref:`step-variables` for more details.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
1 participant
Add warnings and guidance about data persistence behavior in tmt:
This helps users avoid a common pitfall where data stored in TMT_TREE may or may not persist depending on the provisioner used, leading to inconsistent behavior between local development and CI environments.
Assisted-by: Claude Code
Resolves #4543
Pull Request Checklist: