[GitHub] [airflow] potiuk commented on pull request #27946: Add pre-commits preventing accidental API changes in common.sql

Sat, 26 Nov 2022 17:19:05 -0800 


potiuk commented on PR #27946:
URL: https://github.com/apache/airflow/pull/27946#issuecomment-1328146617

   cc: @vincbeck @alexott @oliviervg1 @kazanzhy - this is the pre-commit tests 
that I described in our previous discussions. It should flag any changes to the 
common.sql API when they happen, so that it is not easy to change the API 
accidentally and reviewers can also immediately see that the API has been 
changed.
   
   We are still keeping `_parse_boolean` as part of the public API - even now 
it is used by google provider.
   
   Examples of errors printed when there are changes in the API:
   
   1) When only new methods are added, the contributor will have to just commit 
the change:
   
   <img width="860" alt="Screenshot 2022-11-27 at 02 10 29" 
src="https://user-images.githubusercontent.com/595491/204114804-e44d5e15-8529-486c-886a-6621c56940b7.png";>
   
   <img width="849" alt="Screenshot 2022-11-27 at 02 11 59" 
src="https://user-images.githubusercontent.com/595491/204114827-9b7e9874-9c8c-42b3-9614-5e7616e79c8b.png";>
   
   2) When there is removal, the contributor will have to manually update the 
`api.txt` file:
   
   <img width="786" alt="Screenshot 2022-11-27 at 02 13 16" 
src="https://user-images.githubusercontent.com/595491/204114857-26a7ff97-6558-4c22-b9e4-a56640a4c683.png";>
   
   <img width="933" alt="Screenshot 2022-11-27 at 02 13 36" 
src="https://user-images.githubusercontent.com/595491/204114869-bfa974e2-3081-433d-ab90-ba5bef891565.png";>
   
   3) Similarly- when there is an update, to exisiting API, user will have to 
manually update the `api.txt` file:
   
   <img width="943" alt="Screenshot 2022-11-27 at 02 15 16" 
src="https://user-images.githubusercontent.com/595491/204114913-412af30e-d3b1-4a1b-920d-dc8bb0d4e6da.png";>
   
   <img width="791" alt="Screenshot 2022-11-27 at 02 18 40" 
src="https://user-images.githubusercontent.com/595491/204114988-35e7d667-14aa-402b-9870-14fda4a6c644.png";>
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to