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

Remove newlines from JSON schema files #10486

Merged
merged 1 commit into from
Jul 26, 2024
Merged

Remove newlines from JSON schema files #10486

merged 1 commit into from
Jul 26, 2024

Conversation

courtneyholcomb
Copy link
Contributor

@courtneyholcomb courtneyholcomb commented Jul 25, 2024

resolves: #10455

Problem

The Artifact Schema Check in CI has been consistently failing due to a conflict between the schema generator and the pre-commit hook end-of-file-fixer. The hook adds newlines to the end of JSON files, but the schema generator expects no newlines. When the results are compared, we see a diff, resulting in a CI error.

Solution

Remove newlines from JSON schema files and exclude them from the files modified by end-of-file-fixer.

Checklist

  • I have read the contributing guide and understand what's expected of me.
  • I have run this code in development, and it appears to resolve the stated issue.
  • This PR includes tests, or tests are not required or relevant for this PR.
  • This PR has no interface changes (e.g., macros, CLI, logs, JSON artifacts, config files, adapter interface, etc.) or this PR has already received feedback and approval from Product or DX.
  • This PR includes type annotations for new and modified functions.

@courtneyholcomb courtneyholcomb added the Skip Changelog Skips GHA to check for changelog file label Jul 25, 2024
@cla-bot cla-bot bot added the cla:yes label Jul 25, 2024
@courtneyholcomb courtneyholcomb marked this pull request as ready for review July 25, 2024 23:32
@courtneyholcomb courtneyholcomb requested review from a team as code owners July 25, 2024 23:32
@courtneyholcomb courtneyholcomb requested review from eddowh and removed request for a team July 25, 2024 23:32
@github-actions github-actions bot added the community This PR is from a community member label Jul 25, 2024
Copy link

codecov bot commented Jul 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.80%. Comparing base (cab6dab) to head (8f37e19).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #10486      +/-   ##
==========================================
- Coverage   88.86%   88.80%   -0.06%     
==========================================
  Files         180      180              
  Lines       22643    22643              
==========================================
- Hits        20121    20108      -13     
- Misses       2522     2535      +13     
Flag Coverage Δ
integration 86.03% <ø> (-0.19%) ⬇️
unit 62.22% <ø> (ø)

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

Components Coverage Δ
Unit Tests 62.22% <ø> (ø)
Integration Tests 86.03% <ø> (-0.19%) ⬇️

@MichelleArk MichelleArk merged commit f9c2b93 into main Jul 26, 2024
78 of 79 checks passed
@MichelleArk MichelleArk deleted the court/schema-lint branch July 26, 2024 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla:yes community This PR is from a community member Skip Changelog Skips GHA to check for changelog file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Artifact Schema Check always detects diff in eof newline
2 participants