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/0.8.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
@pascalberger
pascalberger committed Oct 17, 2019
2 parents 3480839 + 91d5379 commit f062021
Show file tree
Hide file tree
Showing 16 changed files with 45 additions and 47 deletions.
6 changes: 5 additions & 1 deletion .appveyor.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ image: Visual Studio 2017
#---------------------------------#
# Build Script #
#---------------------------------#
install:
# Update to latest NuGet version since we require 5.3.0 for embedded icon
- ps: nuget update -self

build_script:
- ps: .\build.ps1 -Target AppVeyor

Expand All @@ -27,4 +31,4 @@ branches:
# Build Cache #
#---------------------------------#
cache:
- tools -> setup.cake
- tools -> recipe.cake
5 changes: 2 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This addin for the Cake Build Automation System allows you to read issues logged
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)
and for general information about the Cake build automation system see the [Cake website](http://cakebuild.net)
and for general information about the Cake build automation system see the [Cake website](http://cakebuild.net).

[![License](http://img.shields.io/:license-mit-blue.svg)](https://github.com/cake-contrib/Cake.Issues.MsBuild/blob/feature/build/LICENSE)

Expand All @@ -22,7 +22,6 @@ and for general information about the Cake build automation system see the [Cake
|AppVeyor Windows|[![Build status](https://ci.appveyor.com/api/projects/status/7e9bedtgp9m30p4m/branch/develop?svg=true)](https://ci.appveyor.com/project/cakecontrib/cake-issues-msbuild/branch/develop)|[![Build status](https://ci.appveyor.com/api/projects/status/7e9bedtgp9m30p4m/branch/master?svg=true)](https://ci.appveyor.com/project/cakecontrib/cake-issues-msbuild/branch/master)|
|Azure DevOps Windows|[![Build Status](https://dev.azure.com/cake-contrib/Cake.Issues.MsBuild/_apis/build/status/cake-contrib.Cake.Issues.MsBuild?branchName=develop&jobName=Windows)](https://dev.azure.com/cake-contrib/Cake.Issues.MsBuild/_build/latest?definitionId=6?branchName=develop)|[![Build Status](https://dev.azure.com/cake-contrib/Cake.Issues.MsBuild/_apis/build/status/cake-contrib.Cake.Issues.MsBuild?branchName=master&jobName=Windows)](https://dev.azure.com/cake-contrib/Cake.Issues.MsBuild/_build/latest?definitionId=6&branchName=master)|


|Develop|Master|
|:--:|:--:|
|[![Build status](https://ci.appveyor.com/api/projects/status/7e9bedtgp9m30p4m/branch/develop?svg=true)](https://ci.appveyor.com/project/cakecontrib/cake-issues-msbuild/branch/develop)|[![Build status](https://ci.appveyor.com/api/projects/status/7e9bedtgp9m30p4m/branch/develop?svg=true)](https://ci.appveyor.com/project/cakecontrib/cake-issues-msbuild/branch/master)|
Expand All @@ -37,7 +36,7 @@ and for general information about the Cake build automation system see the [Cake

## Chat Room

Come join in the conversation about this addin in our Gitter Chat Room
Come join in the conversation about this addin in our Gitter Chat Room.

[![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)

Expand Down
2 changes: 2 additions & 0 deletions azure-pipelines.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ trigger:

pr:
- develop
- release/*
- hotfix/*

jobs:
- job: Windows
Expand Down
4 changes: 2 additions & 2 deletions build.ps1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ http://cakebuild.net

[CmdletBinding()]
Param(
[string]$Script = "setup.cake",
[string]$Script = "recipe.cake",
[string]$Target = "Default",
[ValidateSet("Release", "Debug")]
[string]$Configuration = "Release",
Expand Down Expand Up @@ -181,4 +181,4 @@ if (!(Test-Path $CAKE_EXE)) {
# Start Cake
Write-Host "Running build script..."
Invoke-Expression "& `"$CAKE_EXE`" `"$Script`" -target=`"$Target`" -configuration=`"$Configuration`" -verbosity=`"$Verbosity`" $UseMono $UseDryRun $UseExperimental $ScriptArgs"
exit $LASTEXITCODE
exit $LASTEXITCODE
2 changes: 1 addition & 1 deletion build.sh
100644 → 100755
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ NUGET_EXE=$TOOLS_DIR/nuget.exe
CAKE_EXE=$TOOLS_DIR/Cake/Cake.exe

# Define default arguments.
SCRIPT="setup.cake"
SCRIPT="recipe.cake"
TARGET="Default"
CONFIGURATION="Release"
VERBOSITY="verbose"
Expand Down
8 changes: 4 additions & 4 deletions docs/examples.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,10 @@ Task("Read-Issues")
// Read Issues.
var issues =
ReadIssues(
MsBuildIssuesFromFilePath(
logPath,
MsBuildXmlFileLoggerFormat),
repoRootFolder);
MsBuildIssuesFromFilePath(
logPath,
MsBuildXmlFileLoggerFormat),
repoRootFolder);

Information("{0} issues are found.", issues.Count());
});
Expand Down
36 changes: 15 additions & 21 deletions docs/features.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,29 +16,23 @@ The [Cake.Issues.MsBuild addin] provides the following features.
* [MsBuildBinaryLogFileFormat] alias for reading issues from binary log files.
* [MsBuildXmlFileLoggerFormat] alias for reading issues from log files created by [MSBuild Extension Pack XmlFileLogger].

# Supported comment formats

| | Comment format | Remarks |
|--------------------------------------------------------------------|--------------------------------|--------------------------------|
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IssueCommentFormat.PlainText` | |
| <span class="glyphicon glyphicon-remove" style="color:red"></span> | `IssueCommentFormat.Markdown` | |
| <span class="glyphicon glyphicon-remove" style="color:red"></span> | `IssueCommentFormat.Html` | |

# Supported IIssue properties

| | Property | Remarks |
|------------------------------------------------------------------|-----------------------------------|--------------------------------|
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IIssue.ProviderType` | |
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IIssue.ProviderName` | |
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IIssue.ProjectName` | |
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IIssue.ProjectFileRelativePath` | |
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IIssue.AffectedFileRelativePath` | |
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IIssue.Line` | |
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IIssue.Message` | |
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IIssue.Priority` | Always [IssuePriority.Warning] |
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IIssue.PriorityName` | Always `Warning` |
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IIssue.Rule` | |
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IIssue.RuleUrl` | For code analysis (`CA*`) and StyleCop (`SA*`) warnings. Support for additional rules can be added through a custom [MsBuildAddRuleUrlResolver] |
| | Property | Remarks |
|--------------------------------------------------------------------|-----------------------------------|--------------------------------|
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IIssue.ProviderType` | |
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IIssue.ProviderName` | |
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IIssue.ProjectName` | |
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IIssue.ProjectFileRelativePath` | |
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IIssue.AffectedFileRelativePath` | |
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IIssue.Line` | |
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IIssue.MessageText` | |
| <span class="glyphicon glyphicon-remove" style="color:red"></span> | `IIssue.MessageHtml` | |
| <span class="glyphicon glyphicon-remove" style="color:red"></span> | `IIssue.MessageMarkdown` | |
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IIssue.Priority` | Always [IssuePriority.Warning] |
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IIssue.PriorityName` | Always `Warning` |
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IIssue.Rule` | |
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | `IIssue.RuleUrl` | For code analysis (`CA*`) and StyleCop (`SA*`) warnings. Support for additional rules can be added through a custom [MsBuildAddRuleUrlResolver] |

[Cake.Issues.MsBuild addin]: https://www.nuget.org/packages/Cake.Issues.MsBuild
[MSBuild Extension Pack XmlFileLogger]: http://www.msbuildextensionpack.com/help/4.0.5.0/html/242ab4fd-c2e2-f6aa-325b-7588725aed24.htm
Expand Down
5 changes: 3 additions & 2 deletions nuspec/nuget/Cake.Issues.MsBuild.nuspec
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,15 @@ See the Project Site for an overview of the whole ecosystem of addins for workin
</description>
<license type="expression">MIT</license>
<projectUrl>https://cakeissues.net</projectUrl>
<iconUrl>https://cdn.jsdelivr.net/gh/cake-contrib/graphics@a5cf0f881c390650144b2243ae551d5b9f836196/png/cake-contrib-medium.png</iconUrl>
<icon>icon.png</icon>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<repository type="git" url="https://github.com/cake-contrib/Cake.Issues.MsBuild.git"/>
<copyright>Copyright © BBT Software AG and contributors</copyright>
<tags>Cake Script Cake-Issues Cake-IssueProvider CodeAnalysis Linting MsBuild</tags>
<releaseNotes>https://github.com/cake-contrib/Cake.Issues.MsBuild/releases/tag/0.7.2</releaseNotes>
<releaseNotes>https://github.com/cake-contrib/Cake.Issues.MsBuild/releases/tag/0.8.0</releaseNotes>
</metadata>
<files>
<file src="..\..\..\..\nuspec\nuget\icon.png" target="" />
<file src="netstandard2.0\Cake.Issues.MsBuild.dll" target="lib\netstandard2.0" />
<file src="netstandard2.0\Cake.Issues.MsBuild.pdb" target="lib\netstandard2.0" />
<file src="netstandard2.0\Cake.Issues.MsBuild.xml" target="lib\netstandard2.0" />
Expand Down
Binary file added nuspec/nuget/icon.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 3 additions & 2 deletions setup.cake → recipe.cake
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@
Environment.SetVariableNames();

BuildParameters.SetParameters(
context: Context,
context: Context,
buildSystem: BuildSystem,
sourceDirectoryPath: "./src",
title: "Cake.Issues.MsBuild",
repositoryOwner: "cake-contrib",
repositoryName: "Cake.Issues.MsBuild",
appVeyorAccountName: "cakecontrib",
shouldGenerateDocumentation: false,
shouldRunCodecov: false);
shouldRunCodecov: false,
shouldRunGitVersion: true);

BuildParameters.PrintParameters(Context);

Expand Down
8 changes: 4 additions & 4 deletions src/Cake.Issues.MsBuild.Tests/Cake.Issues.MsBuild.Tests.csproj
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFrameworks>netcoreapp2.0</TargetFrameworks>
<TargetFrameworks>netcoreapp2.1</TargetFrameworks>
<IsPackable>false</IsPackable>
<Product>Cake.Issues</Product>
<Copyright>Copyright © BBT Software AG and contributors</Copyright>
Expand Down Expand Up @@ -40,11 +40,11 @@
</ItemGroup>

<ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.2.0" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.3.0" />
<PackageReference Include="Cake.Core" Version="0.33.0" />
<PackageReference Include="Cake.Testing" Version="0.33.0" />
<PackageReference Include="Cake.Issues" Version="0.7.0" />
<PackageReference Include="Cake.Issues.Testing" Version="0.7.0" />
<PackageReference Include="Cake.Issues" Version="0.8.0" />
<PackageReference Include="Cake.Issues.Testing" Version="0.8.0" />
<PackageReference Include="Shouldly" Version="3.0.2" />
<PackageReference Include="StyleCop.Analyzers" Version="1.1.118" />
<PackageReference Include="xunit" Version="2.4.1" />
Expand Down
1 change: 0 additions & 1 deletion src/Cake.Issues.MsBuild.Tests/FakeMsBuildLogFileFormat.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ public FakeMsBuildLogFileFormat(ICakeLog log)

public override IEnumerable<IIssue> ReadIssues(
MsBuildIssuesProvider issueProvider,
IssueCommentFormat format,
RepositorySettings repositorySettings,
MsBuildIssuesSettings issueProviderSettings)
{
Expand Down
2 changes: 1 addition & 1 deletion src/Cake.Issues.MsBuild.sln
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Cake.Issues.MsBuild.Tests",
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Build", "Build", "{2EBEB9BA-3A3B-4EDC-95C0-44DD001AFFDC}"
ProjectSection(SolutionItems) = preProject
..\setup.cake = ..\setup.cake
..\recipe.cake = ..\recipe.cake
EndProjectSection
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "nuspec", "nuspec", "{3E340FDE-17DA-429E-BC41-AA5F5F5271DB}"
Expand Down
6 changes: 3 additions & 3 deletions src/Cake.Issues.MsBuild/Cake.Issues.MsBuild.csproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@

<ItemGroup>
<PackageReference Include="Cake.Core" Version="0.33.0" />
<PackageReference Include="Cake.Issues" Version="0.7.0" />
<PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.9.4" />
<PackageReference Include="MSBuild.StructuredLogger" Version="2.0.94" />
<PackageReference Include="Cake.Issues" Version="0.8.0" />
<PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.9.6" />
<PackageReference Include="MSBuild.StructuredLogger" Version="2.0.110" />
<PackageReference Include="StyleCop.Analyzers" Version="1.1.118" />
</ItemGroup>

Expand Down
1 change: 0 additions & 1 deletion src/Cake.Issues.MsBuild/LogFileFormat/BinaryLogFileFormat.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ public BinaryLogFileFormat(ICakeLog log)
/// <inheritdoc/>
public override IEnumerable<IIssue> ReadIssues(
MsBuildIssuesProvider issueProvider,
IssueCommentFormat format,
RepositorySettings repositorySettings,
MsBuildIssuesSettings issueProviderSettings)
{
Expand Down
1 change: 0 additions & 1 deletion src/Cake.Issues.MsBuild/LogFileFormat/XmlFileLoggerLogFileFormat.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ public XmlFileLoggerLogFileFormat(ICakeLog log)
/// <inheritdoc/>
public override IEnumerable<IIssue> ReadIssues(
MsBuildIssuesProvider issueProvider,
IssueCommentFormat format,
RepositorySettings repositorySettings,
MsBuildIssuesSettings issueProviderSettings)
{
Expand Down

0 comments on commit f062021

Please sign in to comment.