Skip to content
This repository has been archived by the owner on Dec 25, 2023. It is now read-only.

Commit

Permalink
Merge branch 'release/1.0.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
pascalberger committed Jul 27, 2021
2 parents 92a1abd + 215bfba commit 89fe651
Show file tree
Hide file tree
Showing 9 changed files with 30 additions and 40 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# These owners will be the default owners for everything in the repo and
# will be requested for review when someone opens a pull request.
* @cake-contrib/team-bbt @x-jokay
* @cake-contrib/team-cake-issues
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# DocFx Issue Provider for Cake.Issues Addin

This addin for the Cake Build Automation System allows you to read issues logged as warnings by MsBuild
This addin for the Cake Build Automation System allows you to read issues logged as warnings or suggestions by DocFx
using the [Cake Issues addin](https://github.com/cake-contrib/Cake.Issues).

For more information about this add-in see the [Cake.Issues website](https://cakeissues.net)
Expand Down Expand Up @@ -30,11 +30,11 @@ and for general information about the Cake build automation system see the [Cake

- [Documentation](https://cakeissues.net)

## Chat Room
## Discussion

Come join in the conversation about this addin in our Gitter Chat Room.
For questions and to discuss ideas & feature requests, use the [GitHub discussions on the Cake GitHub repository](https://github.com/cake-build/cake/discussions), under the [Extension Q&A](https://github.com/cake-build/cake/discussions/categories/extension-q-a) category.

[![Join the chat at https://gitter.im/cake-contrib/Lobby](https://badges.gitter.im/cake-contrib/Lobby.svg)](https://gitter.im/cake-contrib/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Join in the discussion on the Cake repository](https://img.shields.io/badge/GitHub-Discussions-green?logo=github)](https://github.com/cake-build/cake/discussions)

## Contributing

Expand Down
4 changes: 2 additions & 2 deletions nuspec/nuget/Cake.Issues.DocFx.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ See the Project Site for an overview of the whole ecosystem of addins for workin
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<repository type="git" url="https://github.com/cake-contrib/Cake.Issues.DocFx.git"/>
<copyright>Copyright © BBT Software AG and contributors</copyright>
<tags>Cake Script Cake-Issues Cake-IssueProvider CodeAnalysis Linting DocFx</tags>
<releaseNotes>https://github.com/cake-contrib/Cake.Issues.DocFx/releases/tag/0.9.0</releaseNotes>
<tags>cake cake-addin cake-issues cake-issueprovider linting docfx</tags>
<releaseNotes>https://github.com/cake-contrib/Cake.Issues.DocFx/releases/tag/1.0.0</releaseNotes>
</metadata>
<files>
<file src="..\..\..\..\nuspec\nuget\icon.png" target="" />
Expand Down
Binary file modified nuspec/nuget/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion recipe.cake
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ BuildParameters.SetParameters(
repositoryName: "Cake.Issues.DocFx",
appVeyorAccountName: "cakecontrib",
shouldGenerateDocumentation: false,
shouldPublishMyGet: false,
shouldRunCodecov: false,
shouldRunGitVersion: true);

Expand All @@ -19,7 +20,7 @@ BuildParameters.PrintParameters(Context);
ToolSettings.SetToolSettings(
context: Context,
dupFinderExcludePattern: new string[] { BuildParameters.RootDirectoryPath + "/src/Cake.Issues.DocFx.Tests/*.cs", BuildParameters.RootDirectoryPath + "/src/Cake.Issues.DocFx*/**/*.AssemblyInfo.cs" },
testCoverageFilter: "+[*]* -[xunit.*]* -[Cake.Core]* -[Cake.Testing]* -[*.Tests]* -[Cake.Issues]* -[Cake.Issues.Testing]* -[Shouldly]*",
testCoverageFilter: "+[*]* -[xunit.*]* -[Cake.Core]* -[Cake.Testing]* -[*.Tests]* -[Cake.Issues]* -[Cake.Issues.Testing]* -[Shouldly]* -[DiffEngine]* -[EmptyFiles]*",
testCoverageExcludeByAttribute: "*.ExcludeFromCodeCoverage*",
testCoverageExcludeByFile: "*/*Designer.cs;*/*.g.cs;*/*.g.i.cs");

Expand Down
20 changes: 6 additions & 14 deletions src/Cake.Issues.DocFx.Tests/Cake.Issues.DocFx.Tests.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -34,19 +34,11 @@
<EmbeddedResource Include="Testfiles\entry-with-line-0.json" />
</ItemGroup>
<ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.6.1" />
<PackageReference Include="Cake.Issues">
<Version>0.9.0</Version>
</PackageReference>
<PackageReference Include="Cake.Issues.Testing">
<Version>0.9.0</Version>
</PackageReference>
<PackageReference Include="Cake.Testing">
<Version>0.33.0</Version>
</PackageReference>
<PackageReference Include="Shouldly">
<Version>3.0.2</Version>
</PackageReference>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.9.1" />
<PackageReference Include="Cake.Issues" Version="1.0.0" />
<PackageReference Include="Cake.Issues.Testing" Version="1.0.0" />
<PackageReference Include="Cake.Testing" Version="1.0.0" />
<PackageReference Include="Shouldly" Version="4.0.3" />
<PackageReference Include="StyleCop.Analyzers">
<Version>1.1.118</Version>
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
Expand All @@ -56,7 +48,7 @@
<Version>2.4.1</Version>
</PackageReference>
<PackageReference Include="xunit.runner.visualstudio">
<Version>2.4.2</Version>
<Version>2.4.3</Version>
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
Expand Down
27 changes: 12 additions & 15 deletions src/Cake.Issues.DocFx/Cake.Issues.DocFx.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -9,30 +9,27 @@
<Product>Cake.Issues</Product>
<Copyright>Copyright © BBT Software AG and contributors</Copyright>
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">

<PropertyGroup>
<DebugType>full</DebugType>
<AnalysisMode>AllEnabledByDefault</AnalysisMode>
<DocumentationFile>bin\Debug\Cake.Issues.DocFx.xml</DocumentationFile>
<CodeAnalysisRuleSet>..\Cake.Issues.DocFx.ruleset</CodeAnalysisRuleSet>
</PropertyGroup>

<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
<DefineConstants>DEBUG;TRACE</DefineConstants>
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
<DocumentationFile>bin\Release\Cake.Issues.DocFx.xml</DocumentationFile>
<CodeAnalysisRuleSet>..\Cake.Issues.DocFx.ruleset</CodeAnalysisRuleSet>
<DefineConstants>TRACE</DefineConstants>
</PropertyGroup>
<PropertyGroup>
<DebugType>full</DebugType>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Cake.Core">
<Version>0.33.0</Version>
</PackageReference>
<PackageReference Include="Cake.Issues">
<Version>0.9.0</Version>
</PackageReference>
<PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers">
<Version>3.0.0</Version>
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
<PackageReference Include="Cake.Core" Version="1.0.0" />
<PackageReference Include="Cake.Issues" Version="1.0.0" />
<PackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="5.0.3">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="StyleCop.Analyzers">
<Version>1.1.118</Version>
Expand Down
2 changes: 1 addition & 1 deletion src/Cake.Issues.DocFx/DocFxIssuesProvider.cs
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ private string TryGetFile(
fileName = fileName.Substring(this.Settings.RepositoryRoot.FullPath.Length);

// Remove leading directory separator.
if (fileName.StartsWith("/"))
if (fileName.StartsWith("/", StringComparison.InvariantCulture))
{
fileName = fileName.Substring(1);
}
Expand Down
4 changes: 2 additions & 2 deletions src/Cake.Issues.DocFx/DocFxIssuesSettings.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public class DocFxIssuesSettings : IssueProviderSettings
/// <summary>
/// Initializes a new instance of the <see cref="DocFxIssuesSettings"/> class.
/// </summary>
/// <param name="logFilePath">Path to the the DocFx log file.</param>
/// <param name="logFilePath">Path to the DocFx log file.</param>
/// <param name="docRootPath">Path to the root directory of the DocFx project.
/// Either the full path or the path relative to the repository root.</param>
public DocFxIssuesSettings(FilePath logFilePath, DirectoryPath docRootPath)
Expand All @@ -24,7 +24,7 @@ public DocFxIssuesSettings(FilePath logFilePath, DirectoryPath docRootPath)
/// <summary>
/// Initializes a new instance of the <see cref="DocFxIssuesSettings"/> class.
/// </summary>
/// <param name="logFileContent">Content of the the DocFx log file.</param>
/// <param name="logFileContent">Content of the DocFx log file.</param>
/// <param name="docRootPath">Path to the root directory of the DocFx project.
/// Either the full path or the path relative to the repository root.</param>
public DocFxIssuesSettings(byte[] logFileContent, DirectoryPath docRootPath)
Expand Down

0 comments on commit 89fe651

Please sign in to comment.