Skip to content

Hide generated proto stubs by default#4947

Merged
eapolinario merged 6 commits intomasterfrom
add-generated-proto-to-gitattributes
Mar 8, 2024
Merged

Hide generated proto stubs by default#4947
eapolinario merged 6 commits intomasterfrom
add-generated-proto-to-gitattributes

Conversation

@eapolinario
Copy link
Copy Markdown
Contributor

@eapolinario eapolinario commented Feb 24, 2024

Tracking issue

NA

Why are the changes needed?

Showing generated code by default is usually not helpful. As documented in https://docs.github.com/en/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github, we can control how files are shown in diffs by default.

What changes were proposed in this pull request?

Add files under flyteidl/gen to .gitattributes. Do the same to the the copied swagger file and rst files.

How was this patch tested?

Setup process

Screenshots

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Related PRs

Docs link

Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com>
Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com>
Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com>
@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. housekeeping Issues that help maintain flyte and keep it tech-debt free labels Feb 24, 2024
@codecov
Copy link
Copy Markdown

codecov bot commented Feb 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 58.97%. Comparing base (94e433b) to head (122572a).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4947   +/-   ##
=======================================
  Coverage   58.96%   58.97%           
=======================================
  Files         645      645           
  Lines       55506    55506           
=======================================
+ Hits        32730    32732    +2     
+ Misses      20177    20174    -3     
- Partials     2599     2600    +1     
Flag Coverage Δ
unittests 58.97% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com>
Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com>
Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com>
@dosubot dosubot bot added size:XS This PR changes 0-9 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Feb 24, 2024
@eapolinario eapolinario changed the title Add generated proto to gitattributes Hide generated proto stubs by default Feb 24, 2024
@eapolinario eapolinario merged commit 028ff98 into master Mar 8, 2024
@eapolinario eapolinario deleted the add-generated-proto-to-gitattributes branch March 8, 2024 19:19
yubofredwang pushed a commit to yubofredwang/flyte that referenced this pull request Mar 26, 2024
* Add flyteidl/gen to .gitattributes

Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com>

* make generate to show a change

Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com>

* Prepend forward slash to rule

Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com>

* Hide copied swagger.json

Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com>

* Move .gitattributes from flyteidl to root

Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com>

* Revert test attribute change

Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com>

---------

Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com>
Co-authored-by: Eduardo Apolinario <eapolinario@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

housekeeping Issues that help maintain flyte and keep it tech-debt free size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant