Add LineEndingPlugin #930
Closed
Add LineEndingPlugin #930
Conversation
This file contains 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
kenlautner
force-pushed
the
personal/klautner/add_LineEndingCheck_plugin
branch
from
78a1c04 to
2a1abfe
Compare
github-actions
bot
added
the
impact:non-functional
kenlautner
force-pushed
the
personal/klautner/add_LineEndingCheck_plugin
branch
from
2a1abfe to
33c6095
Compare
github-actions
bot
added
the
language:python
Adds a simple CI plugin to check file line endings. This is meant to: 1. Supplement the Uncrustify Check plugin which fails if line endings are CRLF but does not obviously indicate that error since it is non-visible whitespace. 2. Discover line endings issues in files not checked by Uncrustify (which only operates against .c and .h files right now). Signed-off-by: Michael Kubacki <[email protected]>
Updates `logging.warn()` to `logging.warning()` to prevent
deprecation warnings like this:
.pytool\Plugin\UncrustifyCheck\UncrustifyCheck.py:386:
DeprecationWarning: The 'warn' function is deprecated, use
'warning' instead
- [ ] Impacts functionality?
- **Functionality** - Does the change ultimately impact how firmware
functions?
- Examples: Add a new library, publish a new PPI, update an algorithm,
...
- [ ] Impacts security?
- **Security** - Does the change have a direct security impact on an
application,
flow, or firmware?
- Examples: Crypto algorithm change, buffer overflow fix, parameter
validation improvement, ...
- [ ] Breaking change?
- **Breaking change** - Will anyone consuming this change experience a
break
in build or boot behavior?
- Examples: Add a new library class, move a module to a different repo,
call
a function in a new library class in a pre-existing module, ...
- [ ] Includes tests?
- **Tests** - Does the change include any explicit test code?
- Examples: Unit tests, integration tests, robot tests, ...
- [ ] Includes documentation?
- **Documentation** - Does the change contain explicit documentation
additions
outside direct code modifications (and comments)?
- Examples: Update readme file, add feature readme file, link to
documentation
on an a separate Web page, ...
- Review Python code for `log.warn()` usage
- Check logs that reported issue earlier after changee
N/A
Signed-off-by: Michael Kubacki <[email protected]>
kenlautner
force-pushed
the
personal/klautner/add_LineEndingCheck_plugin
branch
from
33c6095 to
5d01dd8
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## release/202405 #930 +/- ##
=================================================
Coverage ? 38.73%
=================================================
Files ? 207
Lines ? 27023
Branches ? 2105
=================================================
Hits ? 10467
Misses ? 16542
Partials ? 14
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
This PR has been automatically marked as stale because it has not had activity in 60 days. It will be closed if no further activity occurs within 7 days. Thank you for your contributions. |
|
This pull request has been automatically been closed because it did not have any activity in 60 days and no follow up within 7 days after being marked stale. Thank you for your contributions. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Cherry-pick the LineEndingCheck plugin in its entirety.
The commits included from 202311:
8080124
6ddc3a5
59f3382
24a4f42
418f07b
These commits do the following:
Revert the temporary commit disabling the ARM and ARM64 pipeline builds for CI and Basetools. This ensures that all normal Mu CI is run after this point.
Fixed a bug where the plugin would fail if not run from the projects root directory.
For each item, place an "x" in between
[and]if true. Example:[x].(you can also check items in the GitHub UI)
flow, or firmware?
validation improvement, ...
in build or boot behavior?
a function in a new library class in a pre-existing module, ...
outside direct code modifications (and comments)?
on an a separate Web page, ...
How This Was Tested
N/A
Integration Instructions
N/A