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

Allow specifying env vars for examples/HIL tests #3028

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

bugadani
Copy link
Contributor

Closes #2971

Now we can add ENV metadata lines to tests and examples, and they will be passed to the build process. This isn't limited to esp-config variables.

@bugadani bugadani added CI Continuous integration/deployment skip-changelog No changelog modification needed labels Jan 24, 2025
Copy link
Contributor

@bjoernQ bjoernQ left a comment

Choose a reason for hiding this comment

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

At some point we should document the meta-keys in the README.md, I guess. But out of scope of this PR

@@ -3,6 +3,12 @@

//% CHIPS: esp32 esp32c2 esp32c3 esp32c6 esp32h2 esp32s2 esp32s3
//% FEATURES: unstable embassy
//% ENV(single_integrated): ESP_HAL_EMBASSY_CONFIG_TIMER_QUEUE = single-integrated
Copy link
Member

Choose a reason for hiding this comment

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

Could we get some docs somewhere on how to use this? 🥺 I think I understand now, but it wasn't immediately clear. I think a new contributor would also struggle to grok this.

Copy link
Member

Choose a reason for hiding this comment

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

Or maybe less how to use it, but more what this does to the tests we're about to run

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Technically it's in the code, but in bits and pieces, so I'll try to collect it into the readme.

Copy link
Contributor

Choose a reason for hiding this comment

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

then probably it's worth to add documentation about the meta-keys

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can do that but I don't understand TAG I think.

Copy link
Contributor

@bjoernQ bjoernQ Jan 24, 2025

Choose a reason for hiding this comment

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

TAG is just a name and only used to sort examples for run-example w/o specifying an example (i.e. run all examples one after each other) - but we can leave that out and I document that one (since I added it 😄 )

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added docs to xtask/README.md, let me know if they make sense.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous integration/deployment skip-changelog No changelog modification needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Need a mechanism to test different esp-config configurations
3 participants