Use pipeline to set version

Author: ccheetham

Steeltoe.NetCoreToolService.sln

@@ -28,6 +28,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		stylecop.json = stylecop.json
 		Version.props = Version.props
 		azure-pipelines.yaml = azure-pipelines.yaml
+		setversion.sh = setversion.sh
 	EndProjectSection
 EndProject
 Global

Version.props

@@ -1,7 +1,7 @@
 <Project>
 
   <PropertyGroup>
-    <SteeltoeNetCoreToolServiceVersion>0.1.0</SteeltoeNetCoreToolServiceVersion>
+    <SteeltoeNetCoreToolServiceVersion>0.0.0</SteeltoeNetCoreToolServiceVersion>
   </PropertyGroup>
 
   <PropertyGroup>

azure-pipelines.yaml

@@ -19,20 +19,30 @@ stages:
   - stage: assemble
     displayName: Assemble
     jobs:
-      - job: test
-        displayName: Test
+      - job: build
+        displayName: Build
         pool:
           vmImage: ubuntu-latest
         steps:
+          - task: CmdLine@2
+            displayName: 'Set Version'
+            inputs:
+              script: ./setversion.sh $(Build.BuildNumber)
           - task: UseDotNet@2
             displayName: 'Use .NET Core SDK 5.0'
             inputs:
               packageType: sdk
               version: 5.0.x
           - task: DotNetCoreCLI@2
-            displayName: Unit Test
+            displayName: dotnet build
+            inputs:
+              command: build
+              arguments: --no-restore /p:TreatWarningsAsErrors=True
+          - task: DotNetCoreCLI@2
+            displayName: dotnet test
             inputs:
               command: test
+              arguments: --no-build
       - job: kubernetes
         displayName: Kubernetes
         pool:

setversion.sh

@@ -0,0 +1,77 @@
+#!/usr/bin/env bash
+
+set -e
+
+prog=$(basename $0)
+base_dir=$(cd $(dirname $0) && pwd)
+
+if command -v gsed >/dev/null; then
+  sed=gsed
+else
+  sed=sed
+fi
+
+usage() {
+  cat <<EOF
+USAGE
+      $prog [-h] version
+WHERE
+      version
+              Template version in <major>.<minor>.<patch> format.
+OPTIONS
+      -h      print this message
+DESCRIPTION
+      Updates the NuGet spec and DevOps pipeline with the specified version.
+EOF
+}
+
+die() {
+  echo $* 2>&1
+  exit 1
+}
+
+while getopts ":h" opt ; do
+  case $opt in
+    h)
+      usage
+      exit
+      ;;
+    \?)
+      die "invalid option -$OPTARG; run with -h for help"
+      ;;
+    :)
+      die "option -$OPTARG requires an argument; run with -h for help"
+      ;;
+  esac
+done
+shift $(($OPTIND - 1))
+
+if [ $# -eq 0 ]; then
+  die "version not specified; run with -h for help"
+fi
+
+version=$(echo $1 | cut -d- -f1)
+shift
+
+if [ $# -gt 0 ]; then
+  die "too many args; run with -h for help"
+fi
+
+major=$(echo $version | cut -d. -f1)
+minor=$(echo $version | cut -d. -f2)
+patch=$(echo $version | cut -d. -f3)
+
+if [[ "$major.$minor.$patch" != "$version" ]]; then
+  die "version not in major.minor.patch format"
+fi
+[[ $major =~ ^-?[0-9]+$ ]] || die "invalid major value: $major"
+[[ $minor =~ ^-?[0-9]+$ ]] || die "invalid minor value: $minor"
+[[ $patch =~ ^-?[0-9]+$ ]] || die "invalid patch value: $patch"
+
+if ! $sed --version 2>/dev/null | grep 'GNU sed' >/dev/null; then
+  die "This script requires GNU sed"
+fi
+
+echo "Setting version to $major.$minor.$patch"
+
+$sed -i 's:<SteeltoeNetCoreToolServiceVersion>.*</SteeltoeNetCoreToolServiceVersion>:<SteeltoeNetCoreToolServiceVersion>'$major.$minor.$patch'</SteeltoeNetCoreToolServiceVersion>:' $base_dir/Version.props

src/NetCoreToolService/Models/About.cs

@@ -0,0 +1,31 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information.
+
+namespace Steeltoe.NetCoreToolService.Models
+{
+    /// <summary>
+    /// Application information, such as version.
+    /// </summary>
+    public sealed class About
+    {
+        /* ----------------------------------------------------------------- *
+         * properties                                                        *
+         * ----------------------------------------------------------------- */
+
+        /// <summary>
+        /// Gets or sets the application name.
+        /// </summary>
+        public string Name { get; set; }
+
+        /// <summary>
+        /// Gets or sets the application version.
+        /// </summary>
+        public string Version { get; set; }
+
+        /// <summary>
+        /// Gets or sets the application build source control commit ID.
+        /// </summary>
+        public string Commit { get; set; }
+    }
+}

src/NetCoreToolService/Program.cs

@@ -5,6 +5,8 @@
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.Hosting;
 using Steeltoe.Extensions.Logging;
+using Steeltoe.NetCoreToolService.Models;
+using System.Reflection;
 
 namespace Steeltoe.NetCoreToolService
 {
@@ -13,6 +15,34 @@ namespace Steeltoe.NetCoreToolService
     /// </summary>
     public class Program
     {
+        static Program()
+        {
+            var versionAttr =
+                typeof(Program).Assembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>();
+            var fields = versionAttr?.InformationalVersion.Split('+');
+            if (fields is null)
+            {
+                fields = new[] { "unknown" };
+            }
+
+            if (fields.Length == 1)
+            {
+                fields = new[] { fields[0], "unknown" };
+            }
+
+            About = new About
+            {
+                Name = typeof(Program).Namespace ?? "unknown",
+                Version = fields[0],
+                Commit = fields[1],
+            };
+        }
+
+        /// <summary>
+        /// Gets or sets "About" details, such as version.
+        /// </summary>
+        public static About About { get; set; }
+
         /// <summary>
         /// Program entrypoint.
         /// </summary>

src/NetCoreToolService/Startup.cs

@@ -7,6 +7,7 @@
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Logging;
 using Microsoft.OpenApi.Models;
 using Steeltoe.Common.Utils.Diagnostics;
 using Steeltoe.Management.Endpoint;
@@ -56,8 +57,12 @@ public void ConfigureServices(IServiceCollection services)
         /// </summary>
         /// <param name="app">Injected IApplicationBuilder.</param>
         /// <param name="env">Injected IWebHostEnvironment.</param>
-        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
+        /// <param name="logger">Injected ILogger.</param>
+        public void Configure(IApplicationBuilder app, IWebHostEnvironment env, ILogger<Startup> logger)
         {
+            var about = Program.About;
+            logger.LogInformation("{Program}, version {Version} [{Commit}]", about.Name, about.Version, about.Commit);
+
             if (env.IsDevelopment())
             {
                 app.UseDeveloperExceptionPage();