Add formatting step to CI workflow#101
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR strengthens CI quality gates by adding an automated formatting verification step, and normalizes source encoding by ensuring C# files in the OpenApiWeaver project are saved as UTF-8 with BOM (consistent with the repository’s .editorconfig).
Changes:
- Added a
dotnet format --verify-no-changesstep to the CI workflow to block unformatted code from merging. - Updated C# source files to use UTF-8 BOM (shown in diffs as an invisible BOM prefix at the start of the first line).
Reviewed changes
Copilot reviewed 47 out of 47 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| .github/workflows/ci.yml | Adds a formatting verification step to CI. |
| src/OpenApiWeaver/OpenApi/SchemaTypeResolver.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/OpenApi/SchemaReferenceResolver.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/OpenApi/SchemaPropertyCollector.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/OpenApi/SchemaEnumResolver.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/OpenApi/SchemaCatalog.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/OpenApi/SchemaAnalysisCache.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Models/GenerationModels.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Models/CSharpTypeReference.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/GlobalUsings.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Generator/Transforming/ClientGenerator.Transformer.Tags.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Generator/Transforming/ClientGenerator.Transformer.Security.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Generator/Transforming/ClientGenerator.Transformer.Schemas.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Generator/Transforming/ClientGenerator.Transformer.Responses.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Generator/Transforming/ClientGenerator.Transformer.RequestBodies.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Generator/Transforming/ClientGenerator.Transformer.Parameters.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Generator/Transforming/ClientGenerator.Transformer.Operations.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Generator/Transforming/ClientGenerator.Transformer.Naming.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Generator/Transforming/ClientGenerator.Transformer.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Generator/Transforming/ClientGenerator.Transformer.Content.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Generator/SupportTypes/ClientGenerator.SupportTypesEmitter.Response.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Generator/SupportTypes/ClientGenerator.SupportTypesEmitter.Query.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Generator/SupportTypes/ClientGenerator.SupportTypesEmitter.ParameterFormatting.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Generator/SupportTypes/ClientGenerator.SupportTypesEmitter.Helpers.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Generator/SupportTypes/ClientGenerator.SupportTypesEmitter.Exceptions.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Generator/SupportTypes/ClientGenerator.SupportTypesEmitter.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Generator/SupportTypes/ClientGenerator.SupportTypesEmitter.Cookie.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Generator/ClientGenerator.Input.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Generator/ClientGenerator.Emitter.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Generator/ClientGenerator.DocumentReader.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Generator/ClientGenerator.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/Diagnostics/OpenApiWeaverDiagnostics.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/CodeGeneration/SupportTypeNames.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/CodeGeneration/SchemaEmitter.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/CodeGeneration/OperationRequestBodyEmitter.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/CodeGeneration/OperationEmitter.Serialization.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/CodeGeneration/OperationEmitter.Security.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/CodeGeneration/OperationEmitter.Parameters.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/CodeGeneration/OperationEmitter.ErrorResponses.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/CodeGeneration/OperationEmitter.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/CodeGeneration/JsonSerializerOptionsEmitter.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/CodeGeneration/JsonSerializerDirection.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/CodeGeneration/IndentedStringBuilder.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/CodeGeneration/EnumSchemaEmitter.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/CodeGeneration/DictionarySchemaConverterEmitter.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/CodeGeneration/CSharpUtilities.cs | Ensures UTF-8 BOM encoding (no logical code change). |
| src/OpenApiWeaver/CodeGeneration/CSharpCodeEmissionUtilities.cs | Ensures UTF-8 BOM encoding (no logical code change). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
This pull request introduces a formatting check in the CI workflow and updates several source files to ensure they use a UTF-8 BOM (Byte Order Mark). The main goal is to enforce consistent code formatting and encoding across the codebase.
CI/CD improvements:
dotnet formatstep to the CI workflow (.github/workflows/ci.yml) to verify code formatting and prevent unformatted code from being merged.Code formatting and encoding consistency:
OpenApiWeaverproject to include a UTF-8 BOM by adding a BOM-prefixedusingstatement at the top of each file. This ensures consistent encoding and can help prevent issues with certain tools or editors. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19]