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

github-avoid-http-files #462

Merged
merged 7 commits into from
Dec 17, 2023
Merged

github-avoid-http-files #462

merged 7 commits into from
Dec 17, 2023

Conversation

reuvenharrison
Copy link
Collaborator

@reuvenharrison reuvenharrison commented Dec 12, 2023

Prior to this PR githubactions format would always include file=<file> in the annotations.
However, the file is only relevant if it is local in which case the GitHub annotation can be clicked to see the relevant file diff.
Specs that were given as a URL or stdin should not be included in GitHub annotations.

The PR enhances githubactions format to include file=<file> only when the file is in the local filesystem.
To achieve this I changed ApiChange.Source type from string to load.Source which has an IsFile method.

Side effects:

  • Removed serialization from ApiChange, ComponentChange and SecurityChange
  • Removed "original_source" from source in APIRemovedCheck

Todo:

  • Check annotations in different use cases and make sure the links are useful
  • Add line numbers to annotations

@codecov-commenter
Copy link

codecov-commenter commented Dec 12, 2023

Codecov Report

Attention: 45 lines in your changes are missing coverage. Please review.

Comparison is base (04c0f8c) 83.14% compared to head (53ec8b6) 83.76%.
Report is 1 commits behind head on main.

Files Patch % Lines
checker/check-api-sunset-changed.go 20.00% 4 Missing ⚠️
...quest-parameter-x-extensible-enum-value-removed.go 0.00% 3 Missing ⚠️
...equest-property-x-extensible-enum-value-removed.go 0.00% 3 Missing ⚠️
checker/checker.go 25.00% 3 Missing ⚠️
checker/check-api-removed.go 75.00% 2 Missing ⚠️
checker/check-request-property-max-length-set.go 0.00% 2 Missing ⚠️
checker/check-request-property-max-set.go 0.00% 2 Missing ⚠️
...cker/check-request-property-min-items-increased.go 0.00% 2 Missing ⚠️
checker/check-request-property-min-items-set.go 0.00% 2 Missing ⚠️
checker/check-request-property-min-set.go 0.00% 2 Missing ⚠️
... and 16 more

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #462      +/-   ##
==========================================
+ Coverage   83.14%   83.76%   +0.61%     
==========================================
  Files         217      217              
  Lines       12536    12550      +14     
==========================================
+ Hits        10423    10512      +89     
+ Misses       1742     1663      -79     
- Partials      371      375       +4     
Flag Coverage Δ
unittests 83.76% <81.70%> (+0.61%) ⬆️

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.

@reuvenharrison reuvenharrison requested review from effoeffi and removed request for effoeffi December 17, 2023 13:01
@reuvenharrison reuvenharrison merged commit d3e5ade into main Dec 17, 2023
8 checks passed
@reuvenharrison reuvenharrison deleted the github-avoid-http-files branch December 17, 2023 13:04
effoeffi added a commit to oasdiff/oasdiff that referenced this pull request Feb 1, 2024
* add flag to control colorful output (Tufin#433)

* Bump github.com/oasdiff/go-common from 0.2.27 to 0.2.28 (Tufin#444)

* color-flag completion (Tufin#447)

* Bump cloud.google.com/go from 0.110.10 to 0.111.0 (Tufin#448)

* prevent---color-with-non-text-formats (Tufin#449)

* upgrade-to-kin-openapi-v0.122.0 (Tufin#450)

* diff-add-exclude-elements-options (Tufin#454)

* remove-hardcoded-quotes (Tufin#455)

* Correct int messages (Tufin#456)

* fix test (Tufin#457)

* add qr code (Tufin#458)

* typo

* github-annotations-with-api (Tufin#452)

* add source file to github (Tufin#459)

* Change sample sunset date to self-explain that it's YYYY-MM-DD format (Tufin#460)

* github-avoid-http-files (Tufin#462)

* Update ALLOF.md

* flatten command - fix wrong Title and Description values (Tufin#464)

* flatten command - prune oneOf field on circular references (Tufin#466)

* lower-min-go-ver (Tufin#471)

* update Breaking Changes to Enum Values

* Bump cloud.google.com/go from 0.111.0 to 0.112.0 (Tufin#472)

* delta (Tufin#473)

* add property name to the response's type/format change message (Tufin#477)

* documentation (Tufin#478)

* Update DELTA.md (Tufin#480)

---------

Co-authored-by: Reuven Harrison <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: effoeffi <[email protected]>
Co-authored-by: Maciej Lewiński <[email protected]>
Co-authored-by: Omer E <[email protected]>
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.

2 participants