Better diagnostics in case someone modified the dependencies file #24763
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eladkal
approved these changes
Jun 30, 2022
The "provider_dependencies.json" file gets automatically generated by pre-commit and in case it cannot be json-parsed, it will break building the CI image. This is a bit chicken-egg because on CI the image is needed to run pre-commits that could warn the user this is the case (and the image fails build with a bit cryptic message). This PR improves the diagnostics: * it runs the pre-commit check before image building which will fix the generated file (and will let the build run - only to fail at the latest static-checks step * it prints warning to the user seeing pre-commit error to not modify the file manually but let pre-commit do the job.
potiuk
force-pushed
the
add-better-dependencies-diagnostics
branch
from
a943509 to
1daff1c
Compare
Member
Author
|
By looking at the output I realized two things were missing:
Both are added @eladkal |
eladkal
approved these changes
Jul 1, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The "provider_dependencies.json" file gets automatically generated
by pre-commit and in case it cannot be json-parsed, it will break
building the CI image. This is a bit chicken-egg because on
CI the image is needed to run pre-commits that could warn the
user this is the case (and the image fails build with a bit
cryptic message).
This PR improves the diagnostics:
it runs the pre-commit check before image building which will
fix the generated file (and will let the build run - only to
fail at the latest static-checks step
it prints warning to the user seeing pre-commit error to not
modify the file manually but let pre-commit do the job.
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code change, Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragement file, named
{pr_number}.significant.rst, in newsfragments.