ci: move from dotnet-format tool to .NET SDK command #4918
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -28,17 +28,28 @@ jobs: | |
| dotnet workload restore | ||
| dotnet restore Sentry.slnx --nologo | ||
|
|
||
| - name: Format Code | ||
| # We exclude `./**/*OptionsSetup.cs` from the format because the tool struggles with | ||
| # source generators. | ||
| # | ||
| # We exclude `test/Sentry.Tests/AttributeReaderTests.cs` because dotnet-format tries to | ||
| # delete assertions in there. | ||
| # - see https://github.com/getsentry/sentry-dotnet/pull/4911#discussion_r2795717887 | ||
| run: dotnet format Sentry.slnx --no-restore --report ./dotnet-format-report --exclude ./modules ./**/*OptionsSetup.cs ./test/Sentry.Tests/AttributeReaderTests.cs | ||
|
|
||
| - name: Upload Format Report | ||
| if: ${{ always() }} | ||
| uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 | ||
| with: | ||
| archive: false | ||
| path: ./dotnet-format-report/ | ||
| if-no-files-found: ignore | ||
|
|
||
|
Comment on lines
+40
to
+47
Member
Author
There was a problem hiding this comment. note: see e.g. https://github.com/getsentry/sentry-dotnet/actions/runs/22679547094?pr=4918 I do like the unzipped upload for single files, so that in this case I can view the |
||
| - name: Exclude Format Report from Git | ||
| run: | | ||
| if [ -d ./dotnet-format-report ]; then | ||
| echo '*' > ./dotnet-format-report/.gitignore | ||
| fi | ||
|
|
||
|
Comment on lines
+48
to
53
Member
Author
There was a problem hiding this comment. note: so that the |
||
| # actions/checkout fetches only a single commit in a detached HEAD state. Therefore | ||
| # we need to pass the current branch, otherwise we can't commit the changes. | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Upload failure blocks formatted code commit step
Medium Severity
The
Upload Format Reportstep usesif: always()but lackscontinue-on-error: true. If this step fails (e.g., network issue, orarchive: falserejecting multiple files from the report directory), the GitHub Actionssuccess()check becomes false, preventing bothExclude Format Report from GitandCommit Formatted Codefrom running. This silently discards any formatting changes thatdotnet formatapplied. Addingcontinue-on-error: trueto the upload step would prevent an informational artifact upload from blocking the core commit functionality.Additional Locations (1)
.github/workflows/format-code.yml#L47-L52There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
my intention was that CI should fail if anything goes unexpected ... starting out more aggressive ... we can always loosen strictness later