Merge pull request #297 from ChangemakerStudios/feature/docker-build

Add Docker build and multi-platform support to GitHub Actions

Author: Jaben

.github/workflows/build.yml

@@ -21,6 +21,8 @@ jobs:
   build:
     name: Build Papercut SMTP
     runs-on: windows-2022
+    permissions:
+      contents: write
 
     steps:
       - name: Checkout code
@@ -63,38 +65,62 @@ jobs:
           path: releases/*
           if-no-files-found: warn
 
-      - name: Create GitHub Release (master only)
+      - name: Attach Service artifacts to release (master only)
         if: github.ref == 'refs/heads/master' && github.event_name == 'push'
         uses: softprops/action-gh-release@v2
         with:
           tag_name: v${{ steps.gitversion.outputs.semVer }}
-          name: Release v${{ steps.gitversion.outputs.semVer }}
-          body: |
-            ## Release Notes
-
-            This is an automated release for Papercut SMTP v${{ steps.gitversion.outputs.semVer }}.
-
-            See [ReleaseNotes.md](https://github.com/ChangemakerStudios/Papercut-SMTP/blob/master/ReleaseNotes.md) for details.
-          draft: false
-          prerelease: false
-          files: releases/*
+          files: releases/Papercut.Smtp.Service.*.zip
+          fail_on_unmatched_files: false
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Create Pre-release (develop only)
+      - name: Attach Service artifacts to pre-release (develop only)
         if: github.ref == 'refs/heads/develop' && github.event_name == 'push'
         uses: softprops/action-gh-release@v2
         with:
           tag_name: v${{ steps.gitversion.outputs.semVer }}
-          name: Pre-release v${{ steps.gitversion.outputs.semVer }}
-          body: |
-            ## Development Pre-release
-
-            This is an automated pre-release build from the develop branch.
-
-            **Version:** ${{ steps.gitversion.outputs.fullSemVer }}
-          draft: false
-          prerelease: true
-          files: releases/*
+          files: releases/Papercut.Smtp.Service.*.zip
+          fail_on_unmatched_files: false
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up Docker Buildx
+        if: (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/develop') && github.event_name == 'push'
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to Docker Hub
+        if: (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/develop') && github.event_name == 'push'
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Extract Docker metadata
+        if: (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/develop') && github.event_name == 'push'
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: changemakerstudios/papercut-smtp
+          tags: |
+            type=raw,value=latest,enable=${{ github.ref == 'refs/heads/master' }}
+            type=raw,value=dev,enable=${{ github.ref == 'refs/heads/develop' }}
+            type=raw,value=${{ steps.gitversion.outputs.fullSemVer }},enable=${{ github.ref == 'refs/heads/develop' }}
+            type=semver,pattern={{version}},value=${{ steps.gitversion.outputs.semVer }},enable=${{ github.ref == 'refs/heads/master' }}
+            type=semver,pattern={{major}}.{{minor}},value=${{ steps.gitversion.outputs.semVer }},enable=${{ github.ref == 'refs/heads/master' }}
+
+      - name: Build and push Docker image
+        if: (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/develop') && github.event_name == 'push'
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            BUILD_VERSION=${{ steps.gitversion.outputs.fullSemVer }}
+            BUILD_DATE=${{ github.event.repository.updated_at }}
+            VCS_REF=${{ github.sha }}
+          platforms: linux/amd64,linux/arm64
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

.gitignore

@@ -24,3 +24,4 @@ src/Papercut.UI/Releases
 publish
 Releases
 .angular
+settings.local.json

build.cake

@@ -1,12 +1,12 @@
 
 #tool "nuget:?package=System.Configuration.ConfigurationManager&version=4.5.0"
 #tool "nuget:?package=MarkdownSharp&version=2.0.5"
-#tool "nuget:?package=MimekitLite&version=4.5.0"
+#tool "nuget:?package=MimekitLite&version=4.14.0"
 #tool "nuget:?package=NUnit.ConsoleRunner&version=3.17.0"
 #tool "nuget:?package=OpenCover&version=4.7.1221"
 
-#tool "dotnet:?package=GitVersion.Tool&version=5.12.0"
-#tool "dotnet:?package=vpk&version=0.0.359"
+#tool "dotnet:?package=GitVersion.Tool&version=6.4.0"
+#tool "dotnet:?package=vpk&version=0.0.1298"
 
 #addin "nuget:?package=Cake.FileHelpers&version=6.1.3"
 #addin "nuget:?package=Cake.Incubator&version=8.0.0"
@@ -28,22 +28,16 @@ var configuration = Argument("configuration", "Release");
 var target = Argument("target", "All");
 GitVersion versionInfo = GitVersion(new GitVersionSettings { OutputType = GitVersionOutput.Json });
 
-var isMasterBranch = false;
-var isDevelopBranch = false;
-var hasGithubToken = false;
-string? githubToken = null;
+var isRunningInGitHubActions = !string.IsNullOrEmpty(EnvironmentVariable("GITHUB_ACTIONS"));
+var branchName = EnvironmentVariable("GITHUB_REF_NAME") ?? versionInfo.BranchName;
+var isMasterBranch = StringComparer.OrdinalIgnoreCase.Equals("master", branchName);
+var isDevelopBranch = StringComparer.OrdinalIgnoreCase.Equals("develop", branchName);
+var githubToken = EnvironmentVariable<string?>("GITHUB_TOKEN", null);
+var hasGithubToken = !string.IsNullOrEmpty(githubToken);
 
-if (AppVeyor.IsRunningOnAppVeyor)
+if (isRunningInGitHubActions)
 {
-    Information($"Building Branch '{BuildSystem.AppVeyor.Environment.Repository.Branch}'...");
-    isMasterBranch = StringComparer.OrdinalIgnoreCase.Equals("master", BuildSystem.AppVeyor.Environment.Repository.Branch);
-    isDevelopBranch = StringComparer.OrdinalIgnoreCase.Equals("develop", BuildSystem.AppVeyor.Environment.Repository.Branch);
-    githubToken = EnvironmentVariable<string?>("github-token", null);
-}
-
-if (!string.IsNullOrEmpty(githubToken))
-{
-    hasGithubToken = true;
+    Information($"Building Branch '{branchName}'...");
 }
 
 var channelPostfix = isMasterBranch ? "-stable" : isDevelopBranch ? "-dev" : "-alpha";
@@ -54,11 +48,7 @@ var channelPostfix = isMasterBranch ? "-stable" : isDevelopBranch ? "-dev" : "-a
 Setup(ctx =>
 {
     Information("Running tasks...");
-
-    if (AppVeyor.IsRunningOnAppVeyor)
-    {
-        AppVeyor.UpdateBuildVersion(versionInfo.SemVer);
-    }
+    Information($"Version: {versionInfo.SemVer}");
 });
 
 Teardown(ctx => Information("Finished running tasks."));
@@ -112,23 +102,6 @@ Task("Restore")
     DotNetRestore("./Papercut.sln");
 });
 
-Task("DownloadReleases")
-    .WithCriteria(hasGithubToken)
-    .IsDependentOn("Restore")
-    .Does(() =>
-{
-    var arguments = new ProcessArgumentBuilder()
-        .Append("download").Append("github")
-        .Append("--repoUrl").Append("https://github.com/ChangemakerStudios/Papercut-SMTP")
-        .Append("--token").Append(EnvironmentVariable<string>("github-token", ""));
-
-    StartProcess("vpk", new ProcessSettings
-    {
-        Arguments = arguments
-    });
-})
-.OnError(exception => Error(exception));
-
 ///////////////////////////////////////////////////////////////////////////////
 // BUILD
 Task("BuildUI64")
@@ -211,29 +184,29 @@ Task("PackageUI32")
 .OnError(exception => Error(exception));
 
 Task("DeployReleases")
-    .WithCriteria(AppVeyor.IsRunningOnAppVeyor && isMasterBranch && hasGithubToken)
+    .WithCriteria(isRunningInGitHubActions && isMasterBranch && hasGithubToken)
     .Does(() =>
     {
-        Information($"Uploading Papercut SMTP 64-bit Release {GitVersionOutput.BuildServer}");
+        Information($"Uploading Papercut SMTP 64-bit Release {versionInfo.FullSemVer}");
 
         var uploadParams = new VpkUploadParams
         {
             Channel = "win-x64" + channelPostfix,
             ReleaseDirectory = releasesDirectory,
-            Token = EnvironmentVariable<string>("github-token", ""),
+            Token = githubToken ?? "",
             Repository = "https://github.com/ChangemakerStudios/Papercut-SMTP",
             IsPrelease = !isMasterBranch
         };
 
         Velopack.UploadGithub(Context, uploadParams);
 
-        Information($"Uploading Papercut SMTP 32-bit Release {GitVersionOutput.BuildServer}");
+        Information($"Uploading Papercut SMTP 32-bit Release {versionInfo.FullSemVer}");
 
         uploadParams = new VpkUploadParams
         {
             Channel = "win-x86" + channelPostfix,
             ReleaseDirectory = releasesDirectory,
-            Token = EnvironmentVariable<string>("github-token", ""),
+            Token = githubToken ?? "",
             Repository = "https://github.com/ChangemakerStudios/Papercut-SMTP",
             IsPrelease = !isMasterBranch
         };
@@ -248,8 +221,6 @@ Task("BuildAndPackServiceWin64")
     .Does(() =>
 {
     CleanDirectory(publishDirectory);
-    CleanDirectory(releasesDirectory);
-
     var runtime = "win-x64";
 
     var settings = new DotNetPublishSettings
@@ -298,32 +269,17 @@ Task("BuildAndPackServiceWin32")
 })
 .OnError(exception => Error(exception));
 
-Task("UploadArtifacts")
-    .WithCriteria(AppVeyor.IsRunningOnAppVeyor)
-    .IsDependentOn("BuildAndPackServiceWin32")
-    .Does(() =>
-    {
-        foreach (var file in GetFiles(releasesDirectory.ToString() + "/**/*.zip"))
-        {
-            Information($"Uploading Artifact to AppVeyor: {file}");
-            AppVeyor.UploadArtifact(file);
-        }
-    })
-.OnError(exception => Error(exception));
-
 ///////////////////////////////////////////////////////////////////////////////
 Task("All")
     .IsDependentOn("Clean")
     .IsDependentOn("PatchAssemblyInfo")
     .IsDependentOn("CreateReleaseNotes")
-    .IsDependentOn("DownloadReleases")
     .IsDependentOn("Restore")
     .IsDependentOn("BuildUI32").IsDependentOn("PackageUI32")
     .IsDependentOn("BuildUI64").IsDependentOn("PackageUI64")
     .IsDependentOn("DeployReleases")
     .IsDependentOn("BuildAndPackServiceWin64")
     .IsDependentOn("BuildAndPackServiceWin32")
-    .IsDependentOn("UploadArtifacts")
     .OnError(exception => Error(exception));
 
 RunTarget(target);

src/Papercut.UI/Papercut.csproj

@@ -67,7 +67,7 @@
 		<PackageReference Include="Serilog.Sinks.Seq" Version="9.0.0" />
 		<PackageReference Include="System.Net.Http" Version="4.3.4" />
 		<PackageReference Include="System.Text.RegularExpressions" Version="4.3.1" />
-		<PackageReference Include="Velopack" Version="0.0.1053" />
+		<PackageReference Include="Velopack" Version="0.0.1298" />
 	</ItemGroup>
 	<ItemGroup>
 		<Resource Include="Resources\attachment-icon.png" />