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

Re-evaluate checked-in generated sources #78

Open
jannic opened this issue Jul 23, 2023 · 2 comments
Open

Re-evaluate checked-in generated sources #78

jannic opened this issue Jul 23, 2023 · 2 comments

Comments

@jannic
Copy link
Member

jannic commented Jul 23, 2023

The generated sources in src/ cause a lot of noise in merge requests.

Evaluate if there is a better way. As @ithinuel wrote in the matrix room: "I'm starting to wonder if you shan't remove the src from the main branch and rather have a pipeline run and generate a parallel branch with the generated code ala gh-pages."

Disadvantages of a separate branch could be:

  • Increased workflow complexity
  • Repo layout less obvious, especially for casual observers and newcomers
  • Reviewers can't easily see the effect of changes on the resulting crate
@jannic jannic mentioned this issue Jul 23, 2023
@jannic jannic changed the title Re-evaluate checked in generated sources Re-evaluate checked-in generated sources Jul 25, 2023
@AkiyukiOkayasu
Copy link
Contributor

I agree that it is difficult to review, but it is easier for beginners to understand if the source is in the main branch.

I think it is the regression caused by svd2rust or svdtool updates that we should be worried about.
I have not fully researched this yet, but what about including rp2040 in svd2rust-regress?

@ithinuel
Copy link
Member

We could keep the branch with the generated sources as the visible branch but ask for contributions to be made on a dev branch.

This'd keep the best of both worlds for the cost of slightly increased complexity for contributors.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants