From c68061fa0c72a7f287380106fc47b5e728a3cb30 Mon Sep 17 00:00:00 2001 From: Eddy Nakamura Date: Fri, 31 Jul 2020 22:46:08 -0300 Subject: [PATCH] dotnet-format check (#958) * dotnet-format check updating name updating order Update dotnet-format.yml updating job name Updating files based on dotnet-format updating sanitycheck updating os * updating workflows * adding path to editorconfig Co-authored-by: Mikel Blanchard --- .github/workflows/dotnet-format.yml | 27 +++++++++++++++++++ .github/workflows/integration.yml | 2 +- OpenTelemetry.sln | 12 +++++---- .../Controllers/WeatherForecastController.cs | 3 +-- .../Controllers/WeatherForecastController.cs | 2 +- .../Context/DistributedContext.cs | 2 +- .../Context/DistributedContextBuilder.cs | 2 +- .../ActivitySpanIdConverter.cs | 2 +- .../ActivityTraceIdConverter.cs | 2 +- .../AssemblyInfo.cs | 2 +- .../Implementation/TimestampHelpers.cs | 2 +- .../Metrics/BoundCounterMetricSdkBase.cs | 2 +- .../Metrics/BoundMeasureMetricSdkBase.cs | 2 +- .../Metrics/CounterMetricSdkBase.cs | 2 +- .../SpanShimTests.cs | 2 +- .../Controllers/ValuesController.cs | 4 +-- 16 files changed, 49 insertions(+), 21 deletions(-) create mode 100644 .github/workflows/dotnet-format.yml diff --git a/.github/workflows/dotnet-format.yml b/.github/workflows/dotnet-format.yml new file mode 100644 index 000000000..388aa3845 --- /dev/null +++ b/.github/workflows/dotnet-format.yml @@ -0,0 +1,27 @@ +name: dotnet format + +on: + pull_request: + branches: [ master ] + paths: + - '**.cs' + - '.editorconfig' + +jobs: + check-format: + runs-on: windows-latest + + steps: + - name: check out code + uses: actions/checkout@v2 + + - name: Setup .NET Core 3.1 + uses: actions/setup-dotnet@v1 + with: + dotnet-version: 3.1.x + + - name: Install format tool + run: dotnet tool install -g dotnet-format + + - name: dotnet format + run: dotnet-format --folder --check diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml index 5e8336304..9986d3043 100644 --- a/.github/workflows/integration.yml +++ b/.github/workflows/integration.yml @@ -23,4 +23,4 @@ jobs: steps: - uses: actions/checkout@v2 - name: Run sql docker-compose.integration - run: docker-compose --file=test/OpenTelemetry.Instrumentation.SqlClient.Tests/docker-compose.integration.yml --project-directory=. up --exit-code-from=sql_integration_tests --build \ No newline at end of file + run: docker-compose --file=test/OpenTelemetry.Instrumentation.SqlClient.Tests/docker-compose.integration.yml --project-directory=. up --exit-code-from=sql_integration_tests --build diff --git a/OpenTelemetry.sln b/OpenTelemetry.sln index 605d5c8f2..cfbdcbe34 100644 --- a/OpenTelemetry.sln +++ b/OpenTelemetry.sln @@ -106,12 +106,15 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "ISSUE_TEMPLATE", "ISSUE_TEM EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{E69578EB-B456-4062-A645-877CD964528B}" ProjectSection(SolutionItems) = preProject - .github\workflows\docs.yml = .github\workflows\docs.yml + .github\workflows\docfx.yml = .github\workflows\docfx.yml .github\workflows\dotnet-core-cov.yml = .github\workflows\dotnet-core-cov.yml .github\workflows\dotnet-core-linux.yml = .github\workflows\dotnet-core-linux.yml .github\workflows\dotnet-core-win.yml = .github\workflows\dotnet-core-win.yml .github\workflows\dotnet-core.yml = .github\workflows\dotnet-core.yml + .github\workflows\dotnet-format.yml = .github\workflows\dotnet-format.yml .github\workflows\integration.yml = .github\workflows\integration.yml + .github\workflows\markdownlint.yml = .github\workflows\markdownlint.yml + .github\workflows\sanitycheck.yml = .github\workflows\sanitycheck.yml EndProjectSection EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{C1542297-8763-4DF4-957C-489ED771C21D}" @@ -153,15 +156,14 @@ EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{7C87CAF9-79D7-4C26-9FFB-F3F1FB6911F1}" ProjectSection(SolutionItems) = preProject docs\logs\building-your-own-exporter.md = docs\logs\building-your-own-exporter.md - docs\logs\getting-started.md = docs\logs\getting-started.md - docs\logs\logging-correlation.md = docs\logs\logging-correlation.md docs\trace\building-your-own-exporter.md = docs\trace\building-your-own-exporter.md docs\metrics\building-your-own-exporter.md = docs\metrics\building-your-own-exporter.md - docs\metrics\getting-started.md = docs\metrics\getting-started.md - docs\trace\building-your-own-exporter.md = docs\trace\building-your-own-exporter.md docs\trace\building-your-own-instrumentation-library.md = docs\trace\building-your-own-instrumentation-library.md docs\trace\building-your-own-sampler.md = docs\trace\building-your-own-sampler.md + docs\logs\getting-started.md = docs\logs\getting-started.md + docs\metrics\getting-started.md = docs\metrics\getting-started.md docs\trace\getting-started.md = docs\trace\getting-started.md + docs\logs\logging-correlation.md = docs\logs\logging-correlation.md EndProjectSection EndProject Global diff --git a/examples/AspNet/Controllers/WeatherForecastController.cs b/examples/AspNet/Controllers/WeatherForecastController.cs index 927c113c2..d80a32b46 100644 --- a/examples/AspNet/Controllers/WeatherForecastController.cs +++ b/examples/AspNet/Controllers/WeatherForecastController.cs @@ -4,9 +4,8 @@ using System.Diagnostics; using System.Linq; using System.Net; using System.Net.Http; -using System.Web.Http; using System.Threading.Tasks; - +using System.Web.Http; using Examples.AspNet.Models; namespace Examples.AspNet.Controllers diff --git a/examples/AspNetCore/Controllers/WeatherForecastController.cs b/examples/AspNetCore/Controllers/WeatherForecastController.cs index 846a09588..ab5a7e908 100644 --- a/examples/AspNetCore/Controllers/WeatherForecastController.cs +++ b/examples/AspNetCore/Controllers/WeatherForecastController.cs @@ -2,8 +2,8 @@ using System.Collections.Generic; using System.Linq; using System.Net.Http; -using Microsoft.AspNetCore.Mvc; using Examples.AspNetCore.Models; +using Microsoft.AspNetCore.Mvc; namespace Examples.AspNetCore.Controllers { diff --git a/src/OpenTelemetry.Api/Context/DistributedContext.cs b/src/OpenTelemetry.Api/Context/DistributedContext.cs index b26c4d982..36aa29fff 100644 --- a/src/OpenTelemetry.Api/Context/DistributedContext.cs +++ b/src/OpenTelemetry.Api/Context/DistributedContext.cs @@ -1,4 +1,4 @@ -// +// // Copyright The OpenTelemetry Authors // // Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/src/OpenTelemetry.Api/Context/DistributedContextBuilder.cs b/src/OpenTelemetry.Api/Context/DistributedContextBuilder.cs index 8ce41da2b..20147ab25 100644 --- a/src/OpenTelemetry.Api/Context/DistributedContextBuilder.cs +++ b/src/OpenTelemetry.Api/Context/DistributedContextBuilder.cs @@ -1,4 +1,4 @@ -// +// // Copyright The OpenTelemetry Authors // // Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/src/OpenTelemetry.Exporter.Console/ActivitySpanIdConverter.cs b/src/OpenTelemetry.Exporter.Console/ActivitySpanIdConverter.cs index fe787d767..5c87160e3 100644 --- a/src/OpenTelemetry.Exporter.Console/ActivitySpanIdConverter.cs +++ b/src/OpenTelemetry.Exporter.Console/ActivitySpanIdConverter.cs @@ -1,4 +1,4 @@ -// +// // Copyright The OpenTelemetry Authors // // Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/src/OpenTelemetry.Exporter.Console/ActivityTraceIdConverter.cs b/src/OpenTelemetry.Exporter.Console/ActivityTraceIdConverter.cs index d06960ef0..5dc24f458 100644 --- a/src/OpenTelemetry.Exporter.Console/ActivityTraceIdConverter.cs +++ b/src/OpenTelemetry.Exporter.Console/ActivityTraceIdConverter.cs @@ -1,4 +1,4 @@ -// +// // Copyright The OpenTelemetry Authors // // Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/AssemblyInfo.cs b/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/AssemblyInfo.cs index ea64d99b2..80f10e05d 100644 --- a/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/AssemblyInfo.cs +++ b/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/AssemblyInfo.cs @@ -1,4 +1,4 @@ -// +// // Copyright The OpenTelemetry Authors // // Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/TimestampHelpers.cs b/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/TimestampHelpers.cs index d288dcb3c..426680239 100644 --- a/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/TimestampHelpers.cs +++ b/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/TimestampHelpers.cs @@ -1,4 +1,4 @@ -// +// // Copyright The OpenTelemetry Authors // // Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/src/OpenTelemetry/Metrics/BoundCounterMetricSdkBase.cs b/src/OpenTelemetry/Metrics/BoundCounterMetricSdkBase.cs index 04b8bbe51..7463b3543 100644 --- a/src/OpenTelemetry/Metrics/BoundCounterMetricSdkBase.cs +++ b/src/OpenTelemetry/Metrics/BoundCounterMetricSdkBase.cs @@ -1,4 +1,4 @@ -// +// // Copyright The OpenTelemetry Authors // // Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/src/OpenTelemetry/Metrics/BoundMeasureMetricSdkBase.cs b/src/OpenTelemetry/Metrics/BoundMeasureMetricSdkBase.cs index f76998218..d39ed0d3b 100644 --- a/src/OpenTelemetry/Metrics/BoundMeasureMetricSdkBase.cs +++ b/src/OpenTelemetry/Metrics/BoundMeasureMetricSdkBase.cs @@ -1,4 +1,4 @@ -// +// // Copyright The OpenTelemetry Authors // // Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/src/OpenTelemetry/Metrics/CounterMetricSdkBase.cs b/src/OpenTelemetry/Metrics/CounterMetricSdkBase.cs index 615fd16a3..5217c00ae 100644 --- a/src/OpenTelemetry/Metrics/CounterMetricSdkBase.cs +++ b/src/OpenTelemetry/Metrics/CounterMetricSdkBase.cs @@ -1,4 +1,4 @@ -// +// // Copyright The OpenTelemetry Authors // // Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/test/OpenTelemetry.Shims.OpenTracing.Tests/SpanShimTests.cs b/test/OpenTelemetry.Shims.OpenTracing.Tests/SpanShimTests.cs index f7f08a789..2f795e1e4 100644 --- a/test/OpenTelemetry.Shims.OpenTracing.Tests/SpanShimTests.cs +++ b/test/OpenTelemetry.Shims.OpenTracing.Tests/SpanShimTests.cs @@ -105,7 +105,7 @@ namespace OpenTelemetry.Shims.OpenTracing.Tests // parameter validation Assert.Throws(() => shim.GetBaggageItem(null)); - // TODO - Method not implemented + // TODO - Method not implemented } [Fact] diff --git a/test/TestApp.AspNetCore.3.1/Controllers/ValuesController.cs b/test/TestApp.AspNetCore.3.1/Controllers/ValuesController.cs index 4db2929b8..798074629 100644 --- a/test/TestApp.AspNetCore.3.1/Controllers/ValuesController.cs +++ b/test/TestApp.AspNetCore.3.1/Controllers/ValuesController.cs @@ -37,13 +37,13 @@ namespace TestApp.AspNetCore._3._1.Controllers // POST api/values [HttpPost] - public void Post([FromBody]string value) + public void Post([FromBody] string value) { } // PUT api/values/5 [HttpPut("{id}")] - public void Put(int id, [FromBody]string value) + public void Put(int id, [FromBody] string value) { }