Skip to content

Commit b1428ca

Browse files
Merge pull request #2166 from microsoft/fix/rename-readers
BREAKING CHANGE: Rename Microsoft.OpenApi.Readers to Microsoft.OpenApi.YamlReader
2 parents 0fe2ab2 + 47a391b commit b1428ca

38 files changed

+59
-63
lines changed

.azure-pipelines/ci-build.yml

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -141,13 +141,13 @@ extends:
141141
displayName: 'pack OpenAPI'
142142

143143
# Pack readers
144-
- pwsh: dotnet pack $(Build.SourcesDirectory)/src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj -o $(Build.ArtifactStagingDirectory) --configuration $(BuildConfiguration) --no-build --include-symbols --include-source /p:SymbolPackageFormat=snupkg
144+
- pwsh: dotnet pack $(Build.SourcesDirectory)/src/Microsoft.OpenApi.YamlReader/Microsoft.OpenApi.YamlReader.csproj -o $(Build.ArtifactStagingDirectory) --configuration $(BuildConfiguration) --no-build --include-symbols --include-source /p:SymbolPackageFormat=snupkg
145145
displayName: 'pack Readers'
146146

147147
# Pack hidi
148-
- pwsh: dotnet pack $(Build.SourcesDirectory)/src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj -o $(Build.ArtifactStagingDirectory) --configuration $(BuildConfiguration) --no-build --include-symbols --include-source /p:SymbolPackageFormat=snupkg
149-
displayName: 'pack Hidi'
150-
148+
# - pwsh: dotnet pack $(Build.SourcesDirectory)/src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj -o $(Build.ArtifactStagingDirectory) --configuration $(BuildConfiguration) --no-build --include-symbols --include-source /p:SymbolPackageFormat=snupkg
149+
# displayName: 'pack Hidi'
150+
151151
- task: EsrpCodeSigning@5
152152
displayName: 'ESRP CodeSigning Nuget Packages'
153153
inputs:
@@ -183,14 +183,14 @@ extends:
183183
PendingAnalysisWaitTimeoutMinutes: '5'
184184

185185
# publish hidi as an .exe
186-
- task: DotNetCoreCLI@2
187-
displayName: publish Hidi as executable
188-
inputs:
189-
command: 'publish'
190-
arguments: -c Release --runtime win-x64 /p:PublishSingleFile=true /p:PackAsTool=false --self-contained --output $(Build.ArtifactStagingDirectory)/Microsoft.OpenApi.Hidi
191-
projects: 'src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj'
192-
publishWebProjects: False
193-
zipAfterPublish: false
186+
# - task: DotNetCoreCLI@2
187+
# displayName: publish Hidi as executable
188+
# inputs:
189+
# command: 'publish'
190+
# arguments: -c Release --runtime win-x64 /p:PublishSingleFile=true /p:PackAsTool=false --self-contained --output $(Build.ArtifactStagingDirectory)/Microsoft.OpenApi.Hidi
191+
# projects: 'src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj'
192+
# publishWebProjects: False
193+
# zipAfterPublish: false
194194

195195
- task: CopyFiles@2
196196
displayName: Prepare staging folder for upload
@@ -244,7 +244,7 @@ extends:
244244
vmImage: ubuntu-latest
245245
steps:
246246
- powershell: |
247-
$fileNames = "$(Pipeline.Workspace)/Microsoft.OpenApi.Hidi.*.nupkg", "$(Pipeline.Workspace)/Microsoft.OpenApi.Readers.*.nupkg", "$(Pipeline.Workspace)/Microsoft.OpenApi.Workbench.*.nupkg"
247+
$fileNames = "$(Pipeline.Workspace)/Microsoft.OpenApi.Hidi.*.nupkg", "$(Pipeline.Workspace)/Microsoft.OpenApi.YamlReader.*.nupkg", "$(Pipeline.Workspace)/Microsoft.OpenApi.Workbench.*.nupkg"
248248
foreach($fileName in $fileNames) {
249249
if(Test-Path $fileName) {
250250
rm $fileName -Verbose
@@ -278,7 +278,7 @@ extends:
278278
- task: 1ES.PublishNuget@1
279279
displayName: 'NuGet push'
280280
inputs:
281-
packagesToPush: '$(Pipeline.Workspace)/Microsoft.OpenApi.Readers.*.nupkg'
281+
packagesToPush: '$(Pipeline.Workspace)/Microsoft.OpenApi.YamlReader.*.nupkg'
282282
packageParentPath: '$(Pipeline.Workspace)'
283283
nuGetFeedType: external
284284
publishFeedCredentials: 'OpenAPI Nuget Connection'

.github/workflows/codeql-analysis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ jobs:
3838
run: |
3939
$projectsArray = @(
4040
'.\src\Microsoft.OpenApi\Microsoft.OpenApi.csproj',
41-
'.\src\Microsoft.OpenApi.Readers\Microsoft.OpenApi.Readers.csproj',
41+
'.\src\Microsoft.OpenApi.YamlReader\Microsoft.OpenApi.YamlReader.csproj',
4242
'.\src\Microsoft.OpenApi.Hidi\Microsoft.OpenApi.Hidi.csproj'
4343
)
4444

Microsoft.OpenApi.sln

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
1414
EndProject
1515
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.OpenApi.Workbench", "src\Microsoft.OpenApi.Workbench\Microsoft.OpenApi.Workbench.csproj", "{6A5E91E5-0441-46EE-AEB9-8334981B7F08}"
1616
EndProject
17-
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.OpenApi.Readers", "src\Microsoft.OpenApi.Readers\Microsoft.OpenApi.Readers.csproj", "{79933258-0126-4382-8755-D50820ECC483}"
17+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.OpenApi.YamlReader", "src\Microsoft.OpenApi.YamlReader\Microsoft.OpenApi.YamlReader.csproj", "{79933258-0126-4382-8755-D50820ECC483}"
1818
EndProject
1919
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.OpenApi.Tests", "test\Microsoft.OpenApi.Tests\Microsoft.OpenApi.Tests.csproj", "{AD83F991-DBF3-4251-8613-9CC54C826964}"
2020
EndProject
@@ -24,10 +24,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{E546B92F-20A
2424
EndProject
2525
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{6357D7FD-2DE4-4900-ADB9-ABC37052040A}"
2626
EndProject
27-
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.OpenApi.Hidi", "src\Microsoft.OpenApi.Hidi\Microsoft.OpenApi.Hidi.csproj", "{254841B5-7DAC-4D1D-A9C5-44FE5CE467BE}"
28-
EndProject
29-
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.OpenApi.Hidi.Tests", "test\Microsoft.OpenApi.Hidi.Tests\Microsoft.OpenApi.Hidi.Tests.csproj", "{D8F799DD-04AC-4A13-B344-45A5B944450A}"
30-
EndProject
3127
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.OpenApi.Trimming.Tests", "test\Microsoft.OpenApi.Trimming.Tests\Microsoft.OpenApi.Trimming.Tests.csproj", "{1D2E0C6E-B103-4CB6-912E-D56FA1501296}"
3228
EndProject
3329
Global
@@ -56,14 +52,6 @@ Global
5652
{1ED3C2C1-E1E7-4925-B4E6-2D969C3F5237}.Debug|Any CPU.Build.0 = Debug|Any CPU
5753
{1ED3C2C1-E1E7-4925-B4E6-2D969C3F5237}.Release|Any CPU.ActiveCfg = Release|Any CPU
5854
{1ED3C2C1-E1E7-4925-B4E6-2D969C3F5237}.Release|Any CPU.Build.0 = Release|Any CPU
59-
{254841B5-7DAC-4D1D-A9C5-44FE5CE467BE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
60-
{254841B5-7DAC-4D1D-A9C5-44FE5CE467BE}.Debug|Any CPU.Build.0 = Debug|Any CPU
61-
{254841B5-7DAC-4D1D-A9C5-44FE5CE467BE}.Release|Any CPU.ActiveCfg = Release|Any CPU
62-
{254841B5-7DAC-4D1D-A9C5-44FE5CE467BE}.Release|Any CPU.Build.0 = Release|Any CPU
63-
{D8F799DD-04AC-4A13-B344-45A5B944450A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
64-
{D8F799DD-04AC-4A13-B344-45A5B944450A}.Debug|Any CPU.Build.0 = Debug|Any CPU
65-
{D8F799DD-04AC-4A13-B344-45A5B944450A}.Release|Any CPU.ActiveCfg = Release|Any CPU
66-
{D8F799DD-04AC-4A13-B344-45A5B944450A}.Release|Any CPU.Build.0 = Release|Any CPU
6755
{1D2E0C6E-B103-4CB6-912E-D56FA1501296}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
6856
{1D2E0C6E-B103-4CB6-912E-D56FA1501296}.Debug|Any CPU.Build.0 = Debug|Any CPU
6957
{1D2E0C6E-B103-4CB6-912E-D56FA1501296}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -78,8 +66,6 @@ Global
7866
{79933258-0126-4382-8755-D50820ECC483} = {E546B92F-20A8-49C3-8323-4B25BB78F3E1}
7967
{AD83F991-DBF3-4251-8613-9CC54C826964} = {6357D7FD-2DE4-4900-ADB9-ABC37052040A}
8068
{1ED3C2C1-E1E7-4925-B4E6-2D969C3F5237} = {6357D7FD-2DE4-4900-ADB9-ABC37052040A}
81-
{254841B5-7DAC-4D1D-A9C5-44FE5CE467BE} = {E546B92F-20A8-49C3-8323-4B25BB78F3E1}
82-
{D8F799DD-04AC-4A13-B344-45A5B944450A} = {6357D7FD-2DE4-4900-ADB9-ABC37052040A}
8369
{1D2E0C6E-B103-4CB6-912E-D56FA1501296} = {6357D7FD-2DE4-4900-ADB9-ABC37052040A}
8470
EndGlobalSection
8571
GlobalSection(ExtensibilityGlobals) = postSolution

src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
</ItemGroup>
4545

4646
<ItemGroup>
47-
<ProjectReference Include="..\Microsoft.OpenApi.Readers\Microsoft.OpenApi.Readers.csproj" />
47+
<ProjectReference Include="..\Microsoft.OpenApi.YamlReader\Microsoft.OpenApi.YamlReader.csproj" />
4848
<ProjectReference Include="..\Microsoft.OpenApi\Microsoft.OpenApi.csproj" />
4949
</ItemGroup>
5050

src/Microsoft.OpenApi.Hidi/OpenApiService.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@
3131
using Microsoft.OpenApi.Models;
3232
using Microsoft.OpenApi.OData;
3333
using Microsoft.OpenApi.Reader;
34-
using Microsoft.OpenApi.Readers;
3534
using Microsoft.OpenApi.Services;
3635
using Microsoft.OpenApi.Writers;
36+
using Microsoft.OpenApi.YamlReader;
3737
using static Microsoft.OpenApi.Hidi.OpenApiSpecVersionHelper;
3838

3939
namespace Microsoft.OpenApi.Hidi

src/Microsoft.OpenApi.Workbench/MainModel.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright (c) Microsoft Corporation. All rights reserved.
1+
// Copyright (c) Microsoft Corporation. All rights reserved.
22
// Licensed under the MIT license.
33

44
using System;
@@ -13,6 +13,7 @@
1313
using Microsoft.OpenApi.Reader;
1414
using Microsoft.OpenApi.Services;
1515
using Microsoft.OpenApi.Validations;
16+
using Microsoft.OpenApi.YamlReader;
1617
using Microsoft.OpenApi.Writers;
1718

1819
namespace Microsoft.OpenApi.Workbench

src/Microsoft.OpenApi.Workbench/Microsoft.OpenApi.Workbench.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
<Resource Include="Themes\Metro\HowToApplyTheme.txt" />
2020
</ItemGroup>
2121
<ItemGroup>
22-
<ProjectReference Include="..\Microsoft.OpenApi.Readers\Microsoft.OpenApi.Readers.csproj" />
22+
<ProjectReference Include="..\Microsoft.OpenApi.YamlReader\Microsoft.OpenApi.YamlReader.csproj" />
2323
<ProjectReference Include="..\Microsoft.OpenApi\Microsoft.OpenApi.csproj" />
2424
</ItemGroup>
2525
<ItemGroup>

src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj renamed to src/Microsoft.OpenApi.YamlReader/Microsoft.OpenApi.YamlReader.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<!-- net6.0 target is present because of the conditional build in OpenApiYamlReader.Read -->
55
<LangVersion>latest</LangVersion>
66
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
7-
<Description>OpenAPI.NET Readers for JSON and YAML documents</Description>
7+
<Description>OpenAPI.NET Reader for YAML documents</Description>
88
<SignAssembly>true</SignAssembly>
99
<IsTrimmable Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)','net5.0'))">true</IsTrimmable>
1010
<IsAotCompatible Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)','net8.0'))">true</IsAotCompatible>

src/Microsoft.OpenApi.Readers/OpenApiReaderSettingsExtensions.cs renamed to src/Microsoft.OpenApi.YamlReader/OpenApiReaderSettingsExtensions.cs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
using Microsoft.OpenApi.Interfaces;
2-
using Microsoft.OpenApi.Models;
3-
using Microsoft.OpenApi.Readers;
1+
using Microsoft.OpenApi.Models;
2+
using Microsoft.OpenApi.YamlReader;
43

54
namespace Microsoft.OpenApi.Reader;
65

src/Microsoft.OpenApi.Readers/OpenApiYamlReader.cs renamed to src/Microsoft.OpenApi.YamlReader/OpenApiYamlReader.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
using System.Linq;
1515
using System.Text;
1616

17-
namespace Microsoft.OpenApi.Readers
17+
namespace Microsoft.OpenApi.YamlReader
1818
{
1919
/// <summary>
2020
/// Reader for parsing YAML files into an OpenAPI document.

0 commit comments

Comments
 (0)