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

add a warning if a build.yml file is found in the doctor command #3616

Merged
merged 1 commit into from
Nov 28, 2023

Conversation

jakemac53
Copy link
Contributor

Fixes #3615

Note that this would only give the warning if running the doctor command, which people may not be in the habit of running, but is typically where we put these kinds of diagnostics.

@schaipipat out of curiosity were you aware of the doctor command? Would this have helped you or not?

Copy link

Package publishing

Package Version Status Publish tag (post-merge)
package:build_runner 2.4.7 ready to publish build_runner-v2.4.7
package:build 2.4.2-wip WIP (no publish necessary)
package:build_config 1.1.2-wip WIP (no publish necessary)
package:scratch_space 1.0.3-wip WIP (no publish necessary)
package:build_test 2.2.2-wip WIP (no publish necessary)
package:build_resolvers 2.4.1 already published at pub.dev
package:build_web_compilers 4.0.7 already published at pub.dev
package:build_runner_core 7.2.12-wip WIP (no publish necessary)
package:build_daemon 4.0.1 already published at pub.dev
package:build_modules 5.0.5 already published at pub.dev

Documentation at https://github.com/dart-lang/ecosystem/wiki/Publishing-automation.

Copy link
Member

@natebosch natebosch left a comment

Choose a reason for hiding this comment

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

This LGTM. We could also consider a verbose log like "No build.yaml configuration file, using defaults." and a different verbose log for when the file is read. Anyone running with -v could see this without having to run a separate doctor command.

@jakemac53
Copy link
Contributor Author

I tried originally putting this into the code that actually looks for these files, but it ended up getting complicated because those APIs are actually called for all transitive packages deps, and don't have access to a logging API. So this was the simplest approach.

@schaipipat
Copy link

@jakemac53 Not really. All the tools that using build_runner never mention about doctor command so I haven't run it when I start facing the issue.

@jakemac53
Copy link
Contributor Author

I am going to go ahead and land this because it is better than not having anything - longer term I think we need to figure out how to promote the doctor command more I think.

@jakemac53 jakemac53 merged commit df76f89 into master Nov 28, 2023
70 checks passed
@jakemac53 jakemac53 deleted the build-yml-check branch November 28, 2023 15:19
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

Successfully merging this pull request may close these issues.

Why build_config only support .yaml extension not both .yaml and .yml?
3 participants