The-Standard-Organization / ADotNet

ADotNet is a.NET library that enables software engineers on the .NET platform to develop AzureDevOps pipelines and Git Actions in C#.
98 stars 34 forks source link

INFRASTRUCTURE: Updated GitHubTasks to support all components #81

Closed cjdutoit closed 1 year ago

cjdutoit commented 1 year ago

Sample program.cs definition with new components:

internal class Program
    {
        static void Main(string[] args)
        {
            var aDotNetClient = new ADotNetClient();

            var githubPipeline = new GithubPipeline
            {
                .  .  .

                Jobs = new Dictionary<string, Job>
                {
                    {
                        "build",
                        new Job
                        {
                            RunsOn = BuildMachines.UbuntuLatest,

                            Steps = new List<GithubTask>
                            {
                                new CheckoutTaskV3
                                {
                                    Name = "Check out"
                                },

                                new SetupDotNetTaskV3
                                {
                                    Name = "Setup .Net",

                                    With = new TargetDotNetVersionV3
                                    {
                                        DotNetVersion = "7.0.201"
                                    }
                                },

                                new RestoreTask
                                {
                                    Name = "Restore"
                                },

                                new DotNetBuildTask
                                {
                                    Name = "Build"
                                },

                                new TestTask
                                {
                                    Name = "Test"
                                }
                            }
                        }
                    },
                    {
                        "add_tag",
                        new Job
                        {
                            RunsOn = BuildMachines.UbuntuLatest,

                            Needs = new string[] { "build" },

                            If =
                                "needs.build.result == 'success' &&" + Environment.NewLine
                                + "github.event.pull_request.merged &&" + Environment.NewLine
                                + "github.event.pull_request.base.ref == 'master' &&" + Environment.NewLine
                                + "startsWith(github.event.pull_request.title, 'RELEASES:') &&" + Environment.NewLine
                                + "contains(github.event.pull_request.labels.*.name, 'RELEASES')",

                            Steps = new List<GithubTask>
                            {
                                new ConfigureGitTask()
                                {
                                    Name = "Configure Git",
                                },

                                new CheckoutTaskV3
                                {
                                    Name = "Checkout code",
                                    With = new Dictionary<string, string>
                                    {
                                        { "token", "${{ secrets.PAT_FOR_TAGGING }}" }
                                    }
                                },

                                new ExtractProjectPropertyTask(
                                    projectRelativePath: "ADotNet/ADotNet.csproj",
                                    propertyName: "Version",
                                    environmentVariableName: "version_number")
                                {
                                    Name = $"Extract Version"
                                },

                                new ExtractProjectPropertyTask(
                                    projectRelativePath: "ADotNet/ADotNet.csproj",
                                    propertyName: "PackageReleaseNotes",
                                    environmentVariableName: "package_release_notes")
                                {
                                    Name = $"Extract Package Release Notes"
                                },

                                new CreateGitHubTagTask(
                                    tagName: "v${{ env.version_number }}",
                                    tagMessage: "Release = v${{ env.version_number }}")
                                {
                                    Name = "Create GitHub Tag",
                                },

                                new CreateGitHubReleaseTask(
                                    releaseName: "Release = v${{ env.version_number }}",
                                    tagName: "v${{ env.version_number }}",
                                    releaseNotes: "${{ env.package_release_notes }}",
                                    githubToken: "${{ secrets.PAT_FOR_TAGGING }}")
                                {
                                    Name = "Create GitHub Release",
                                    Uses = "actions/create-release@v1",
                                },
                            }
                        }
                    },
                    {
                        "publish",
                        new Job
                        {
                            RunsOn = BuildMachines.UbuntuLatest,
                            Needs = new string[] { "add_tag" },

                            If =
                                "needs.add_tag.result == 'success'",

                            Steps = new List<GithubTask> {
                                new CheckoutTaskV3
                                {
                                    Name = "Check out"
                                },

                                new SetupDotNetTaskV3
                                {
                                    Name = "Setup .Net",

                                    With = new TargetDotNetVersionV3
                                    {
                                        DotNetVersion = "7.0.201"
                                    }
                                },

                                new RestoreTask
                                {
                                    Name = "Restore"
                                },

                                new DotNetBuildReleaseTask
                                {
                                    Name = "Build",
                                },

                                new PackNugetTaskWithSymbols
                                {
                                    Name = "Pack NuGet Package",
                                },

                                new NugetPushTask(nugetApiKey: "${{ secrets.NUGET_ACCESS }}")
                                {
                                    Name = "Push NuGet Package",
                                }
                            },
                        }
                    }
                }
            };

            string buildScriptPath = "../../../../.github/workflows/dotnet.yml";
            string directoryPath = Path.GetDirectoryName(buildScriptPath);

            if (!Directory.Exists(directoryPath))
            {
                Directory.CreateDirectory(directoryPath);
            }

            aDotNetClient.SerializeAndWriteToFile(githubPipeline, path: buildScriptPath);
        }

OR with the TagJob and ReleaseJob

static void Main(string[] args)
        {
            var aDotNetClient = new ADotNetClient();

            var githubPipeline = new GithubPipeline
            {
                .  .  .

                Jobs = new Dictionary<string, Job>
                {
                    {
                        "build",
                        new Job
                        {
                            RunsOn = BuildMachines.UbuntuLatest,

                            Steps = new List<GithubTask>
                            {
                                new CheckoutTaskV3
                                {
                                    Name = "Check out"
                                },

                                new SetupDotNetTaskV3
                                {
                                    Name = "Setup .Net",

                                    With = new TargetDotNetVersionV3
                                    {
                                        DotNetVersion = "7.0.201"
                                    }
                                },

                                new RestoreTask
                                {
                                    Name = "Restore"
                                },

                                new DotNetBuildTask
                                {
                                    Name = "Build"
                                },

                                new TestTask
                                {
                                    Name = "Test"
                                }
                            }
                        }
                    },
                    {
                        "add_tag",
                        new TagJob(
                            runsOn: BuildMachines.UbuntuLatest,
                            dependsOn: "build",
                            projectRelativePath: "ADotNet/ADotNet.csproj",
                            githubToken: "${{ secrets.PAT_FOR_TAGGING }}",
                            versionEnvironmentVariableName: "version_number",
                            packageReleaseNotesEnvironmentVariable: "package_release_notes")
                    },
                    {
                        "publish",
                        new PublishJob(
                            runsOn: BuildMachines.UbuntuLatest,
                            dependsOn: "add_tag",
                            nugetApiKey: "${{ secrets.NUGET_ACCESS }}")
                    },
                }
            };

            string buildScriptPath = "../../../../.github/workflows/dotnet.yml";
            string directoryPath = Path.GetDirectoryName(buildScriptPath);

            if (!Directory.Exists(directoryPath))
            {
                Directory.CreateDirectory(directoryPath);
            }

            aDotNetClient.SerializeAndWriteToFile(githubPipeline, path: buildScriptPath);
        }