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

Create the esp-metadata package, update esp-hal build script to use it #1256

Merged
merged 1 commit into from
Mar 13, 2024

Conversation

jessebraham
Copy link
Member

I still need to fill out README.md and write some proper documentation for this package, so opening as a draft for now, but I the code should be fine so I'd like to get some input on this.

We had also discussed creating a build utilities package, so I'm not sure if we want to have esp-metadata and esp-build (or whatever we name it), or if we want to just try and create a single package. Happy to hear any input, I'm kind of a fan of smaller single-use packages in this particular case but I don't feel strongly about this.

If anybody can think of any other functionality that would be useful, I'm more than happy to add it in this PR as well, so just let me know.

@jessebraham jessebraham added the skip-changelog No changelog modification needed label Mar 8, 2024
@bjoernQ
Copy link
Contributor

bjoernQ commented Mar 11, 2024

I'm kind of a fan of smaller single-use packages

Same for me. There might be slightly more maintenance overhead having it split whenever we need changes in both at the same time - not sure if that will ever happen

Another way to think about it might be: Is it likely some crate will use one but doesn't need the other. I think that is true. I can imagine crates using esp-build but don't need esp-metadata

This so far already looks quite good to me

@jessebraham
Copy link
Member Author

jessebraham commented Mar 11, 2024

I've rebased this branch and updated README.md, so I think this should be good to go. I will wait until we get our patch release out tomorrow to merge this, so will continue to stay in draft status for now.

Copy link
Contributor

@JurajSadel JurajSadel left a comment

Choose a reason for hiding this comment

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

LGTM! Just super-useless nitpick, sorry :D

esp-metadata/src/lib.rs Outdated Show resolved Hide resolved
@jessebraham jessebraham marked this pull request as ready for review March 12, 2024 15:37
@jessebraham
Copy link
Member Author

I guess this is ready for final review/merging now.

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.

LGTM

Copy link
Member

@SergioGasquez SergioGasquez left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@jessebraham jessebraham added this pull request to the merge queue Mar 13, 2024
Merged via the queue into esp-rs:main with commit 1f12974 Mar 13, 2024
18 checks passed
@jessebraham jessebraham deleted the feature/esp-metadata branch March 13, 2024 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog No changelog modification needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants