.NET Core App - How to get build number at runtime

Question

I've got a .NET Core MVC app which is built using TFS online, and published to Azure using the Release management stuff in TFS online. All very nice.

What I'd like to do is have my app display the build number somewhere. Doesn't matter where...but for example in a WebAPI endpoint like /api/buildversion.

Can anyone help with how I can get the TFS build number at runtime? When the app is packaged/published is there any file which contains the build number that I can access from the application?

Answer 1

The simple way is that you can store the build number in a file (e.g. appsettings.json), then get this data in app code.

Appsettings.json sample code:

{
  "ConnectionStrings": {
    "DefaultConnection": "Server=(localdb)\\mssqllocaldb;Database=aspnet-WebApplication1-ab933d83-8f4b-4024-9f3c-1aef5339a8f3;Trusted_Connection=True;MultipleActiveResultSets=true"
  },
  "Logging": {
    "IncludeScopes": false,
    "LogLevel": {
      "Default": "Debug",
      "System": "Information",
      "Microsoft": "Information"
    }
  }
  "CodeVersion": {
    "Num": "#{MyBuildNumber}#"
  }
}

1. Install Replace Tokens extension
2. Edit your build definition
3. Click Variables tab and add a variable. (Name: MyBuildNumber, Value:$(Build.BuildNumber))
4. Add Replace Tokens build step before build step

Answer 2

There is an easier way than adding more plugins and libraries. If you are using the web/app deploy method, expand the File Transforms & Variables

Assuming you want to update say a build number value in your appsettings.json

Then just update the variables setting in your release definition of VSTS

Super easy. This is more or less the same steps in Octopus IIRC.