cake-contrib · pascalberger · Apr 13, 2024 · Sep 2, 2018 · Dec 15, 2018 · Dec 15, 2018
@@ -0,0 +1,68 @@
+name: Build and tests
+
+# Workflow Trigger
+on:
+  # Trigger the workflow on a pull request to any branch
+  pull_request:
+  # Triggers the workflow in the event there is a push to master
+  push:
+    branches: 
+      - master
+
+jobs:
+  # Build
+  Build:
+    name: Build
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Get the sources
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+      - name: Fetch all tags and branches
+        run: git fetch --prune --unshallow
+      - name: Install .NET
+        uses: actions/setup-dotnet@4d6c8fcf3c8f7a60068d26b594648e99df24cee3 # v4
+        with:
+          # .NET 5 required for GitVersion
+          dotnet-version: | 
+            5.x
+            6.x
+            7.x
+            8.x
+      - name: Build
+        run: ./build.sh
+        shell: bash
+      - name: Publish NuGet package as build artifact
+        uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4
+        with:
+          name: NuGet Package
+          path: ./BuildArtifacts/Packages/NuGet/
+  # Integration Tests Cake.Issues.PullRequests.GitHubActions Cake Scripting
+  IntegrationTestsPullRequestsGitHubActionsCakeScripting:
+    name: Integration Tests Cake.Issues.PullRequests.GitHubActions Cake Scripting
+    needs: Build
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [
+          windows-2019, windows-2022,
+          # Disabled until https://github.com/cake-contrib/Cake.Issues/issues/514 is fixed
+          # ubuntu-20.04, ubuntu-22.04,
+          macos-11, macos-14]
+        dotnet: [6.x, 7.x, 8.x]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Get the sources
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+      - name: Download build artifact
+        uses: actions/download-artifact@eaceaf801fd36c7dee90939fad912460b18a1ffe # v4
+        with:
+          name: NuGet Package
+          path: ./BuildArtifacts/Packages/NuGet
+      - name: Install .NET
+        uses: actions/setup-dotnet@4d6c8fcf3c8f7a60068d26b594648e99df24cee3 # v4
+        with:
+          dotnet-version: ${{ matrix.dotnet }}
+      - name: Run integration tests
+        run: ./build.sh --verbosity=diagnostic
+        working-directory: ./tests/Cake.Issues.PullRequests.GitHubActions/script-runner/
+        shell: bash
@@ -1,13 +1,14 @@
 # Build & Test Status
 
-## Build / Unit Tests
+## Build / Tests
 
 | CI Server | Runner | Operating System | Develop | Master |
 |:--:|:--:|:--:|:--:|:--:|
 |AppVeyor|N/A|Windows|[![Build status](https://ci.appveyor.com/api/projects/status/sde2oe3lu4kpmw0r/branch/develop?svg=true)](https://ci.appveyor.com/project/cakecontrib/cake-issues/branch/develop)|[![Build status](https://ci.appveyor.com/api/projects/status/sde2oe3lu4kpmw0r/branch/master?svg=true)](https://ci.appveyor.com/project/cakecontrib/cake-issues/branch/master)|
 |Azure Pipelines|N/A|Windows|[![Build Status](https://dev.azure.com/cake-contrib/Cake.Issues/_apis/build/status%2Fcake-contrib.Cake.Issues?branchName=develop&jobName=Build%20%26%20Unit%20Tests&configuration=Build%20%26%20Unit%20Tests%20Windows)](https://dev.azure.com/cake-contrib/Cake.Issues/_build/latest?definitionId=2&branchName=develop)|[![Build Status](https://dev.azure.com/cake-contrib/Cake.Issues/_apis/build/status%2Fcake-contrib.Cake.Issues?branchName=master&jobName=Build%20%26%20Unit%20Tests&configuration=Build%20%26%20Unit%20Tests%20Windows)](https://dev.azure.com/cake-contrib/Cake.Issues/_build/latest?definitionId=2&branchName=master)|
 |Azure Pipelines|N/A|Ubuntu|[![Build Status](https://dev.azure.com/cake-contrib/Cake.Issues/_apis/build/status%2Fcake-contrib.Cake.Issues?branchName=develop&jobName=Build%20%26%20Unit%20Tests&configuration=Build%20%26%20Unit%20Tests%20Ubuntu)](https://dev.azure.com/cake-contrib/Cake.Issues/_build/latest?definitionId=2&branchName=develop)|[![Build Status](https://dev.azure.com/cake-contrib/Cake.Issues/_apis/build/status%2Fcake-contrib.Cake.Issues?branchName=master&jobName=Build%20%26%20Unit%20Tests&configuration=Build%20%26%20Unit%20Tests%20Ubuntu)](https://dev.azure.com/cake-contrib/Cake.Issues/_build/latest?definitionId=2&branchName=master)|
 |Azure Pipelines|N/A|macOS|[![Build Status](https://dev.azure.com/cake-contrib/Cake.Issues/_apis/build/status%2Fcake-contrib.Cake.Issues?branchName=develop&jobName=Build%20%26%20Unit%20Tests&configuration=Build%20%26%20Unit%20Tests%20macOS)](https://dev.azure.com/cake-contrib/Cake.Issues/_build/latest?definitionId=2&branchName=develop)|[![Build Status](https://dev.azure.com/cake-contrib/Cake.Issues/_apis/build/status%2Fcake-contrib.Cake.Issues?branchName=master&jobName=Build%20%26%20Unit%20Tests&configuration=Build%20%26%20Unit%20Tests%20macOS)](https://dev.azure.com/cake-contrib/Cake.Issues/_build/latest?definitionId=2&branchName=master)|
+|GitHub Actions|N/A|Ubuntu|[![Build and tests](https://github.com/cake-contrib/Cake.Issues/actions/workflows/build.yml/badge.svg?branch=develop)](https://github.com/cake-contrib/Cake.Issues/actions/workflows/build.yml)|[![Build and tests](https://github.com/cake-contrib/Cake.Issues/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/cake-contrib/Cake.Issues/actions/workflows/build.yml)|
 
 ## Integration Tests Cake.Issues.GitRepository
 

@@ -126,6 +126,7 @@ For questions and to discuss ideas & feature requests, use the [GitHub discussio
 | [Cake.Issues.PullRequests](https://www.nuget.org/packages/Cake.Issues.PullRequests) | [Cake.Frosting.Issues.PullRequests](https://www.nuget.org/packages/Cake.Frosting.Issues.PullRequests) | Addin providing the aliases for writing issues to pull requests and build servers. |
 | [Cake.Issues.PullRequests.AppVeyor](https://www.nuget.org/packages/Cake.Issues.PullRequests.AppVeyor) | [Cake.Issues.PullRequests.AppVeyor](https://www.nuget.org/packages/Cake.Issues.PullRequests.AppVeyor) | Integration with AppVeyor builds. |
 | [Cake.Issues.PullRequests.AzureDevOps](https://www.nuget.org/packages/Cake.Issues.PullRequests.AzureDevOps) | [Cake.Frosting.Issues.PullRequests.AzureDevOps](https://www.nuget.org/packages/Cake.Frosting.Issues.PullRequests.AzureDevOps) | Integration with Azure DevOps pull requests. |
+| [Cake.Issues.PullRequests.GitHubActions](https://www.nuget.org/packages/Cake.Issues.PullRequests.GitHubActions) | [Cake.Issues.PullRequests.AzureDevOps](https://www.nuget.org/packages/Cake.Issues.PullRequests.AzureDevOps) | Integration with GitHub Actions. |
 | [Cake.Issues.Reporting](https://www.nuget.org/packages/Cake.Issues.Reporting) | [Cake.Frosting.Issues.Reporting](https://www.nuget.org/packages/Cake.Frosting.Issues.Reporting) | Addin providing the aliases for creating reports. |
 | [Cake.Issues.Reporting.Console](https://www.nuget.org/packages/Cake.Issues.Reporting.Console) | [Cake.Frosting.Issues.Reporting.Console](https://www.nuget.org/packages/Cake.Frosting.Issues.Reporting.Console) | Support for reporting issues to the console. |
 | [Cake.Issues.Reporting.Generic](https://www.nuget.org/packages/Cake.Issues.Reporting.Generic) | [Cake.Frosting.Issues.Reporting.Generic](https://www.nuget.org/packages/Cake.Frosting.Issues.Reporting.Generic) | Support for creating reports in any text based format (HTML, Markdown, ...). |

@@ -0,0 +1,7 @@
+---
+Title: Examples
+Description: Examples for using the Cake.Issues.PullRequests.GitHubActions addin.
+---
+<p>@Html.Raw(Model.String(DocsKeys.Description))</p>
+
+@Html.Partial("_ChildPages")
@@ -0,0 +1,54 @@
+---
+Order: 10
+Title: Create annotations in GitHub Actions
+Description: Example how to write issues as annotations to a GitHub Actions build.
+---
+This example shows how to report issues as annotations to a GitHub Actions build.
+
+To report issues as annotations to a GitHub Actions build you need to import the core addin,
+the core pull request addin, the GitHub Actions support and one or more issue providers,
+in this example for JetBrains InspectCode:
+
+```csharp
+#addin "Cake.Issues"
+#addin "Cake.Issues.InspectCode"
+#addin "Cake.Issues.PullRequests"
+#addin "Cake.Issues.PullRequests.GitHubActions"
+```
+
+:::{.alert .alert-warning}
+Please note that you always should pin addins to a specific version to make sure your builds are deterministic and
+won't break due to updates to one of the addins.
+
+See [pinning addin versions](https://cakebuild.net/docs/tutorials/pinning-cake-version#pinning-addin-version) for details.
+:::
+
+In the following task we'll first determine the remote repository URL and
+source branch of the pull request and with this information call the [GitHubActionsBuilds] alias:
+
+```csharp
+Task("ReportIssuesToGitHubActions").Does(() =>
+{
+    var repoRootFolder = MakeAbsolute(Directory("./"));
+
+    ReportIssuesToPullRequest(
+        InspectCodeIssuesFromFilePath(
+            @"C:\build\inspectcode.log"),
+        GitHubActionsBuilds(),
+        repoRootFolder);
+});
+```
+
+The output will show up in the build log grouped by issue provider / run:
+
+![Log output](../githubactions-log-output.png "Log output")
+
+Additionally the issues show up as annotations:
+
+![Annotations](../githubactions-annotations.png "Annotations")
+
+Having issues available as annotations also means that they will be shown in pull requests on the related file / position:
+
+![Pull request integration](../githubactions-pullrequest-integration.png "Pull request integration")
+
+[GitHubActionsBuilds]: ../../../../api/Cake.Issues.PullRequests.GitHubActions/GitHubActionsBuildsAliases/
@@ -0,0 +1,25 @@
+---
+Order: 20
+Title: Features
+Description: Features of the Cake.Issues.PullRequests.GitHubActions addin.
+---
+The [Cake.Issues.PullRequests.GitHubActions addin] creates annotations from issues when running on GitHub actions.
+
+![Pull request integration](githubactions-pullrequest-integration.png "Pull request integration")
+
+# Basic features
+
+* Reports issues as annotations to GitHub Actions builds.
+* Group issues in log output by provider and run information.
+
+# Supported capabilities
+
+The [Cake.Issues.PullRequests.GitHubActions addin] doesn't support any additional capabilities.
+
+|                                                                    | Capability                     | Remarks                        |
+|--------------------------------------------------------------------|--------------------------------|--------------------------------|
+| <span class="glyphicon glyphicon-remove" style="color:red"></span> | Checking commit ID             |                                |
+| <span class="glyphicon glyphicon-remove" style="color:red"></span> | Discussion threads             |                                |
+| <span class="glyphicon glyphicon-remove" style="color:red"></span> | Filtering by modified files    |                                |
+
+[Cake.Issues.PullRequests.GitHubActions addin]: https://www.nuget.org/packages/Cake.Issues.PullRequests.GitHubActions
@@ -0,0 +1,10 @@
+---
+Title: GitHub Actions
+Description: Support for GitHub Actions.
+---
+<p>
+    Support for GitHub Actions is implemented in the
+    <a href="https://www.nuget.org/packages/Cake.Issues.PullRequests.GitHubActions" target="_blank">Cake.Issues.PullRequests.GitHubActions addin</a>.
+</p>
+
+@Html.Partial("_ChildPages")
@@ -0,0 +1,9 @@
+---
+Order: 10
+Title: Requirements
+Description: Requirements for the Cake.Issues.PullRequests.GitHubActions addin.
+---
+The requirements for using the [Cake.Issues.PullRequests.GitHubActions addin] are listed in the [release notes] for any specific version.
+
+[Cake.Issues.PullRequests.GitHubActions addin]: https://www.nuget.org/packages/Cake.Issues.PullRequests.GitHubActions
+[release notes]: release-notes
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="utf-8"?>
+<package xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <metadata xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
+    <id>Cake.Issues.PullRequests.GitHubActions</id>
+    <title>Cake.Issues.PullRequests.GitHubActions</title>
+    <version>0.0.0</version>
+    <authors>Cake Issues contributors</authors>
+    <owners>pascalberger, cake-contrib</owners>
+    <summary>GitHub Actions support for the Cake.Issues addin for Cake Build Automation System</summary>
+    <description>
+GitHub Actions support for the Cake.Issues addin for Cake allows you to report to GitHub Actions builds.
+
+This addin provides the aliases for writing to GitHub Actions builds.
+It also requires the core Cake.Issues and Cake.Issues.PullRequests addins and one or more issue providers.
+
+See the Project Site for an overview of the whole ecosystem of addins for working with issues in Cake scripts.
+    </description>
+    <license type="expression">MIT</license>
+    <projectUrl>https://cakeissues.net</projectUrl>
+    <icon>icon.png</icon>
+    <requireLicenseAcceptance>false</requireLicenseAcceptance>
+    <repository type="git" url="https://github.com/cake-contrib/Cake.Issues"/>
+    <copyright>Copyright © Cake Issues contributors</copyright>
+    <tags>cake cake-addin cake-issues cake-pullrequestsystem issues pullrequest buildserver github github-actions</tags>
+    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/4.0.0</releaseNotes>
+  </metadata>
+  <files>
+    <file src="..\..\..\..\nuspec\nuget\icon.png" target="" />
+    <file src="net6.0\Cake.Issues.PullRequests.GitHubActions.dll" target="lib\net6.0" />
+    <file src="net6.0\Cake.Issues.PullRequests.GitHubActions.pdb" target="lib\net6.0" />
+    <file src="net6.0\Cake.Issues.PullRequests.GitHubActions.xml" target="lib\net6.0" />
+    <file src="net7.0\Cake.Issues.PullRequests.GitHubActions.dll" target="lib\net7.0" />
+    <file src="net7.0\Cake.Issues.PullRequests.GitHubActions.pdb" target="lib\net7.0" />
+    <file src="net7.0\Cake.Issues.PullRequests.GitHubActions.xml" target="lib\net7.0" />
+    <file src="net8.0\Cake.Issues.PullRequests.GitHubActions.dll" target="lib\net8.0" />
+    <file src="net8.0\Cake.Issues.PullRequests.GitHubActions.pdb" target="lib\net8.0" />
+    <file src="net8.0\Cake.Issues.PullRequests.GitHubActions.xml" target="lib\net8.0" />
+  </files>
+</package>
@@ -0,0 +1,37 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net6.0</TargetFramework>
+    <IsPackable>false</IsPackable>
+    <Description>Tests for the Cake.Issues.PullRequests.GitHubActions addin</Description>
+    <Authors>Cake Issues contributors</Authors>
+    <Copyright>Copyright © Cake Issues contributors</Copyright>
+    <Product>Cake.Issues</Product>
+  </PropertyGroup>
+
+  <PropertyGroup>
+    <CodeAnalysisRuleSet>..\Cake.Issues.Tests.ruleset</CodeAnalysisRuleSet>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
+    <PackageReference Include="Cake.Testing" Version="4.0.0" />
+    <PackageReference Include="Shouldly" Version="4.2.1" />
+    <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.556">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="xunit" Version="2.7.1" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.5.8">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\Cake.Issues\Cake.Issues.csproj" />
+    <ProjectReference Include="..\Cake.Issues.Testing\Cake.Issues.Testing.csproj" />
+    <ProjectReference Include="..\Cake.Issues.PullRequests.GitHubActions\Cake.Issues.PullRequests.GitHubActions.csproj" />
+  </ItemGroup>
+
+</Project>
@@ -0,0 +1,15 @@
+namespace Cake.Issues.PullRequests.GitHubActions.Tests
+{
+    using System;
+    using Cake.Issues.Testing;
+    using Cake.Testing;
+    using Shouldly;
+    using Xunit;
+
+    public sealed class GitHubActionsBuildSettingsTests
+    {
+        public sealed class TheCtor
+        {
+        }
+    }
+}
@@ -0,0 +1,35 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
+    <Description>Addin for writing code analyzer or linter issues to GitHub Actions</Description>
+    <Authors>Cake Issues contributors</Authors>
+    <Copyright>Copyright © Cake Issues contributors</Copyright>
+    <Product>Cake.Issues</Product>
+  </PropertyGroup>
+
+  <PropertyGroup>
+    <DebugType>full</DebugType>
+    <DebugSymbols>true</DebugSymbols>
+    <AnalysisMode>AllEnabledByDefault</AnalysisMode>
+    <CodeAnalysisRuleSet>..\Cake.Issues.ruleset</CodeAnalysisRuleSet>
+    <DocumentationFile>bin\$(Configuration)\$(TargetFramework)\Cake.Issues.PullRequests.GitHubActions.xml</DocumentationFile>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Cake.Core" Version="4.0.0" />
+    <PackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="8.0.0">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.556">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\Cake.Issues\Cake.Issues.csproj" />
+    <ProjectReference Include="..\Cake.Issues.PullRequests\Cake.Issues.PullRequests.csproj" />
+  </ItemGroup>
+</Project>
@@ -0,0 +1,14 @@
+namespace Cake.Issues.PullRequests.GitHubActions
+{
+    /// <summary>
+    /// Settings for <see cref="GitHubActionsBuildsAliases"/>.
+    /// </summary>
+    public class GitHubActionsBuildSettings
+    {
+        /// <summary>
+        /// Gets or sets a value indicating whether issues should be grouped by issue provider and run information.
+        /// Enabled by default.
+        /// </summary>
+        public bool GroupIssues { get; set; } = true;
+    }
+}