Skip to content

Commit f659b5d

Browse files
pascalbergerpascalberger
committed
Merge branch 'release/5.1.1'
2 parents bc9c5aa + c8084f5 commit f659b5d

File tree

49 files changed

+365
-138
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+365
-138
lines changed

‎.github/renovate.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,17 @@
1313
"matchStrings": [
1414
"\\s*#\\srenovate:\\sdatasource=(?<datasource>.*?) depName=(?<depName>.*?)( versioning=(?<versioning>.*?))?( extractVersion=(?<extractVersion>.*?))?\\s*.*?_version\\s*:\\s*(?<currentValue>.*)"
1515
]
16+
},
17+
{
18+
"customType": "regex",
19+
"description": "Nuspec files manager",
20+
"fileMatch": ["\\.nuspec$"],
21+
"matchStringsStrategy": "any",
22+
"matchStrings": [
23+
"<dependency\\s+[^>]*?id=\\\"(?<depName>.*?)\\\"\\s+[^>]*?version=\\\"(?<currentValue>.*?)\\\"[^>]*\\/?>"
24+
],
25+
"datasourceTemplate": "nuget",
26+
"versioningTemplate": "nuget"
1627
}
1728
],
1829
"packageRules": [

‎docs/input/api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ hide:
2626
- [Cake.Issues.Markdownlint](https://cakebuild.net/extensions/cake-issues-markdownlint){target="_blank"}
2727
- [Cake.Issues.MsBuild](https://cakebuild.net/extensions/cake-issues-msbuild){target="_blank"}
2828
- [Cake.Issues.Sarif](https://cakebuild.net/extensions/cake-issues-sarif){target="_blank"}
29+
- [Cake.Issues.Tap](https://cakebuild.net/extensions/cake-issues-tap){target="_blank"}
2930
- [Cake.Issues.Terraform](https://cakebuild.net/extensions/cake-issues-terraform){target="_blank"}
3031

3132
</div>

‎docs/input/documentation/contributing/how-to-build.md

Lines changed: 60 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,67 @@ title: How to build addins
33
description: Instructions how to build individual Cake Issues addins.
44
---
55

6-
To build this a package we are using Cake.
6+
## Building addins
77

8-
On Windows PowerShell run:
8+
Ensure the following prerequisites are fulfilled:
99

10-
```powershell
11-
./build
12-
```
10+
* Latest .NET version installed
1311

14-
On OSX/Linux run:
12+
To build the addins and run unit tests [Cake] is used:
1513

16-
```bash
17-
./build.sh
18-
```
14+
=== ":material-microsoft-windows: Windows"
15+
16+
```powershell
17+
.\build.ps1
18+
```
19+
20+
=== ":material-apple: macOS"
21+
22+
```bash
23+
./build.sh
24+
```
25+
26+
=== ":material-linux: Linux"
27+
28+
```bash
29+
./build.sh
30+
```
31+
32+
To run only part of the build a task can be passed using the `--target=<TASK>` syntax:
33+
34+
| Task | Description |
35+
|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
36+
| `DotNetCore-Build` | Builds all addins |
37+
| `Create-NuGet-Packages` | Builds an creates NuGet packages for all addins. The NuGet packages are available in the `BuildArtifacts\Packages\NuGet` directory. |
38+
| `Test` | Builds all addins and runs unit tests. Coverage report is available in the `BuildArtifacts\TestCoverage` directory. |
39+
40+
## Building and running website locally
41+
42+
Ensure the following prerequisites are fulfilled:
43+
44+
* Latest .NET version installed
45+
* Python 3 installed
46+
47+
To build and serve the website [Cake] is used:
48+
49+
=== ":material-microsoft-windows: Windows"
50+
51+
```powershell
52+
.\build.ps1 --target=website
53+
```
54+
55+
=== ":material-apple: macOS"
56+
57+
```bash
58+
./build.sh --target=website
59+
```
60+
61+
=== ":material-linux: Linux"
62+
63+
```bash
64+
./build.sh --target=website
65+
```
66+
67+
Website is available on `http://127.0.0.1:8000/`
68+
69+
[Cake]: https://cakebuild.net/

‎docs/input/documentation/issue-providers/inspectcode/examples.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,10 @@ and write a log file and a task to read issues from the log file and write the n
4747

4848
Task("Analyze-Project").Does(() =>
4949
{
50-
// Run InspectCode.
50+
// Run InspectCode and enforce XML output.
5151
var settings = new InspectCodeSettings() {
52-
OutputFile = logPath
52+
OutputFile = logPath,
53+
ArgumentCustomization = x => x.Append("-f=xml")
5354
};
5455

5556
InspectCode(repoRootPath.CombineWithFilePath("MySolution.sln"), settings);
@@ -103,9 +104,10 @@ and write a log file and a task to read issues from the log file and write the n
103104
{
104105
public override void Run(BuildContext context)
105106
{
106-
// Run InspectCode.
107+
// Run InspectCode and enforce XML output.
107108
var settings = new InspectCodeSettings() {
108-
OutputFile = context.LogPath
109+
OutputFile = context.LogPath,
110+
ArgumentCustomization = x => x.Append("-f=xml")
109111
};
110112
111113
context.InspectCode(

‎docs/input/documentation/issue-providers/inspectcode/features.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,21 @@ icon: material/creation-outline
77
The [Cake.Issues.InspectCode addin]{target="_blank"} provides the following features.
88

99
??? tip "Tip: Running InspectCode"
10-
[JetBrains InsepectCode]{target="_blank"} can be run using the [InspectCode alias]{target="_blank"}.
10+
[JetBrains InspectCode]{target="_blank"} can be run using the [InspectCode alias]{target="_blank"}.
1111

1212
## Basic features
1313

14-
- [x] Reads warnings from [JetBrains InsepectCode]{target="_blank"} log files.
14+
- [x] Reads warnings from [JetBrains InspectCode]{target="_blank"} XML log files.
1515
- [x] Provides URLs for issues containing a Wiki URL.
1616

17+
!!! note
18+
Starting from version 2024.1, the default output format of [JetBrains InspectCode] is Static Analysis Results Interchange Format (SARIF).
19+
The XML format, which was the default in previous versions, will soon be deprecated.
20+
Results in the XML format are still available with the `-f="xml"` parameter.
21+
22+
This issue provider is only for the deprecated XML format.
23+
For the new default SARIF format [Cake.Issues.Sarif] can be used.
24+
1725
## Supported IIssue properties
1826

1927
<div class="annotate" markdown>
@@ -44,6 +52,7 @@ The [Cake.Issues.InspectCode addin]{target="_blank"} provides the following feat
4452
2. Set to `IIssue.MessageText`
4553
3. Can be set while reading issues
4654

47-
[JetBrains InsepectCode]: https://www.jetbrains.com/help/resharper/InspectCode.html
55+
[JetBrains InspectCode]: https://www.jetbrains.com/help/resharper/InspectCode.html
4856
[Cake.Issues.InspectCode addin]: https://cakebuild.net/extensions/cake-issues-inspectcode/
4957
[InspectCode alias]: https://cakebuild.net/dsl/resharper/#InspectCode
58+
[Cake.Issues.Sarif]: ../sarif/index.md

‎docs/input/documentation/issue-providers/inspectcode/index.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,16 @@ title: InspectCode
33
description: Issue provider which allows you to read issues logged by JetBrains Inspect Code.
44
---
55

6-
Support for reading issues reported by [JetBrains Inspect Code](https://www.jetbrains.com/help/resharper/2017.1/InspectCode.html)
7-
is implemented in the [Cake.Issues.InspectCode addin](https://www.nuget.org/packages/Cake.Issues.InspectCode).
6+
Support for reading issues reported by [JetBrains InspectCode]{target="_blank"} in XML format
7+
is implemented in the [Cake.Issues.InspectCode addin]{target="_blank"}.
8+
9+
!!! note
10+
Starting from version 2024.1, the default output format of [JetBrains InspectCode] is Static Analysis Results Interchange Format (SARIF).
11+
The XML format, which was the default in previous versions, will soon be deprecated.
12+
Results in the XML format are still available with the `-f="xml"` parameter.
13+
14+
This issue provider is only for the deprecated XML format.
15+
For the new default SARIF format [Cake.Issues.Sarif] can be used.
816

917
<div class="grid cards" markdown>
1018

@@ -13,3 +21,7 @@ is implemented in the [Cake.Issues.InspectCode addin](https://www.nuget.org/pack
1321
- :material-api: [API](https://cakebuild.net/extensions/cake-issues-inspectcode){target="_blank"}
1422

1523
</div>
24+
25+
[JetBrains InspectCode]: https://www.jetbrains.com/help/resharper/InspectCode.html
26+
[Cake.Issues.InspectCode addin]: https://cakebuild.net/extensions/cake-issues-inspectcode/
27+
[Cake.Issues.Sarif]: ../sarif/index.md

‎docs/input/documentation/issue-providers/markdownlint/features.md

Lines changed: 94 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -32,34 +32,100 @@ provides the following features.
3232

3333
## Supported IIssue properties
3434

35-
<div class="annotate" markdown>
35+
=== "MarkdownlintV1LogFileFormat"
3636

37-
- [x] `IIssue.ProviderType`
38-
- [x] `IIssue.ProviderName`
39-
- [ ] `IIssue.Run` (1)
40-
- [x] `IIssue.Identifier` (2)
41-
- [ ] `IIssue.ProjectName`
42-
- [ ] `IIssue.ProjectFileRelativePath`
43-
- [x] `IIssue.AffectedFileRelativePath`
44-
- [x] `IIssue.Line`
45-
- [ ] `IIssue.EndLine`
46-
- [x] `IIssue.Column` (3)
47-
- [ ] `IIssue.EndColumn`
48-
- [ ] `IIssue.FileLink` (4)
49-
- [x] `IIssue.MessageText`
50-
- [ ] `IIssue.MessageHtml`
51-
- [ ] `IIssue.MessageMarkdown`
52-
- [x] `IIssue.Priority` (5)
53-
- [x] `IIssue.PriorityName` (6)
54-
- [x] `IIssue.RuleId`
55-
- [x] `IIssue.RuleUrl` (7)
37+
<div class="annotate" markdown>
38+
39+
- [x] `IIssue.ProviderType`
40+
- [x] `IIssue.ProviderName`
41+
- [ ] `IIssue.Run` (1)
42+
- [x] `IIssue.Identifier` (2)
43+
- [ ] `IIssue.ProjectName`
44+
- [ ] `IIssue.ProjectFileRelativePath`
45+
- [x] `IIssue.AffectedFileRelativePath`
46+
- [x] `IIssue.Line`
47+
- [ ] `IIssue.EndLine`
48+
- [ ] `IIssue.Column`
49+
- [ ] `IIssue.EndColumn`
50+
- [ ] `IIssue.FileLink` (3)
51+
- [x] `IIssue.MessageText`
52+
- [ ] `IIssue.MessageHtml`
53+
- [ ] `IIssue.MessageMarkdown`
54+
- [x] `IIssue.Priority` (4)
55+
- [x] `IIssue.PriorityName` (5)
56+
- [x] `IIssue.RuleId`
57+
- [x] `IIssue.RuleUrl` (6)
58+
59+
</div>
60+
61+
1. Can be set while reading issues
62+
2. Set to `IIssue.MessageText`
63+
3. Can be set while reading issues
64+
4. Always [IssuePriority.Warning](https://cakebuild.net/api/Cake.Issues/IssuePriority/7A0CE07F){target="_blank"}
65+
5. Always `Warning`
66+
6. Support for custom rules can be added through a custom [MarkdownlintAddRuleUrlResolver](https://cakebuild.net/api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/2EE35F55){target="_blank"}
5667

57-
</div>
68+
=== "MarkdownlintCliLogFileFormat"
5869

59-
1. Can be set while reading issues
60-
2. Set to `IIssue.MessageText`
61-
3. Only for [MarkdownlintCliLogFileFormat](https://cakebuild.net/api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/B518F49E){target="_blank"}
62-
4. Can be set while reading issues
63-
5. Always [IssuePriority.Warning](https://cakebuild.net/api/Cake.Issues/IssuePriority/7A0CE07F){target="_blank"}
64-
6. Always `Warning`
65-
7. Support for custom rules can be added through a custom [MarkdownlintAddRuleUrlResolver](https://cakebuild.net/api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/2EE35F55){target="_blank"} except for [MarkdownlintCliJsonLogFileFormat](https://cakebuild.net/api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/36DE6F5F){target="_blank"}
70+
<div class="annotate" markdown>
71+
72+
- [x] `IIssue.ProviderType`
73+
- [x] `IIssue.ProviderName`
74+
- [ ] `IIssue.Run` (1)
75+
- [x] `IIssue.Identifier` (2)
76+
- [ ] `IIssue.ProjectName`
77+
- [ ] `IIssue.ProjectFileRelativePath`
78+
- [x] `IIssue.AffectedFileRelativePath`
79+
- [x] `IIssue.Line`
80+
- [ ] `IIssue.EndLine`
81+
- [x] `IIssue.Column`
82+
- [ ] `IIssue.EndColumn`
83+
- [ ] `IIssue.FileLink` (3)
84+
- [x] `IIssue.MessageText`
85+
- [ ] `IIssue.MessageHtml`
86+
- [ ] `IIssue.MessageMarkdown`
87+
- [x] `IIssue.Priority` (4)
88+
- [x] `IIssue.PriorityName` (5)
89+
- [x] `IIssue.RuleId`
90+
- [x] `IIssue.RuleUrl` (6)
91+
92+
</div>
93+
94+
1. Can be set while reading issues
95+
2. Set to `IIssue.MessageText`
96+
3. Can be set while reading issues
97+
4. Always [IssuePriority.Warning](https://cakebuild.net/api/Cake.Issues/IssuePriority/7A0CE07F){target="_blank"}
98+
5. Always `Warning`
99+
6. Support for custom rules can be added through a custom [MarkdownlintAddRuleUrlResolver](https://cakebuild.net/api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/2EE35F55){target="_blank"}
100+
101+
=== "MarkdownlintCliJsonLogFileFormat"
102+
103+
<div class="annotate" markdown>
104+
105+
- [x] `IIssue.ProviderType`
106+
- [x] `IIssue.ProviderName`
107+
- [ ] `IIssue.Run` (1)
108+
- [x] `IIssue.Identifier` (2)
109+
- [ ] `IIssue.ProjectName`
110+
- [ ] `IIssue.ProjectFileRelativePath`
111+
- [x] `IIssue.AffectedFileRelativePath`
112+
- [x] `IIssue.Line`
113+
- [x] `IIssue.EndLine`
114+
- [x] `IIssue.Column`
115+
- [x] `IIssue.EndColumn`
116+
- [ ] `IIssue.FileLink` (3)
117+
- [x] `IIssue.MessageText`
118+
- [ ] `IIssue.MessageHtml`
119+
- [ ] `IIssue.MessageMarkdown`
120+
- [x] `IIssue.Priority` (4)
121+
- [x] `IIssue.PriorityName` (5)
122+
- [x] `IIssue.RuleId`
123+
- [x] `IIssue.RuleUrl`
124+
125+
</div>
126+
127+
1. Can be set while reading issues
128+
2. Set to `IIssue.MessageText`
129+
3. Can be set while reading issues
130+
4. Always [IssuePriority.Warning](https://cakebuild.net/api/Cake.Issues/IssuePriority/7A0CE07F){target="_blank"}
131+
5. Always `Warning`

‎docs/input/documentation/issue-providers/msbuild/examples.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ and a task to read issues from the binary log file and write the number of warni
3939
=== "Cake .NET Tool"
4040

4141
```csharp title="build.cake"
42-
var logPath = @"c:\build\msbuild.xml";
42+
var logPath = @"c:\build\msbuild.binlog";
4343
var repoRootPath = MakeAbsolute(Directory("./"));
4444

4545
Task("Build-Solution").Does(() =>
@@ -94,7 +94,7 @@ and a task to read issues from the binary log file and write the number of warni
9494

9595
public class BuildContext(ICakeContext context) : FrostingContext(context)
9696
{
97-
public FilePath LogPath { get; } = @"c:\build\msbuild.xml";
97+
public FilePath LogPath { get; } = @"c:\build\msbuild.binlog";
9898
public DirectoryPath RepoRootPath { get; } =
9999
context.MakeAbsolute(context.Directory("./"));
100100
}
@@ -107,7 +107,7 @@ and a task to read issues from the binary log file and write the number of warni
107107
// Build solution.
108108
var msBuildSettings =
109109
new DotNetMSBuildSettings().WithLogger(
110-
"BinaryLogger," + context.Tools.Resolve("Cake.Issues.MsBuild*/**/StructuredLogger.dll"),
110+
"BinaryLogger," + context.Environment.ApplicationRoot.CombineWithFilePath("StructuredLogger.dll"),
111111
"",
112112
context.LogPath.FullPath);
113113
context.DotNetBuild(

0 commit comments

Comments
 (0)