Change variables in appsettings when deploying with github actions

Question

I am trying to deploy an app with github actions. I linked my azure account to my github repository and the following actions has been created:

name: Build and deploy ASP.Net Core app to Azure Web App - my_app_name

on:
  push:
    branches:
      - master

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@master

    - name: Set up .NET Core
      uses: actions/setup-dotnet@v1
      with:
        dotnet-version: '3.1.102'

    - name: Build with dotnet
      run: dotnet build --configuration Release

    - name: dotnet publish
      run: dotnet publish -c Release -o ${{env.DOTNET_ROOT}}/myapp

    - name: Deploy to Azure Web App
      uses: azure/webapps-deploy@v1
      with:
        app-name: 'my_app_name'
        slot-name: 'production'
        publish-profile: ${{ secrets.AzureAppService_PublishProfile_xxxxxx }}
        package: ${{env.DOTNET_ROOT}}/myapp

I have some variables in my appsettings.json file that I want to overwrite, but I don't find how to do it.

Why not change it before deploy?

suziki
– suziki

2020-03-05 10:58:38 +00:00
Commented Mar 5, 2020 at 10:58 — suziki
– suziki, Commented Mar 5, 2020 at 10:58
Because it contains a secret key

Antoine L
– Antoine L

2020-03-09 18:38:40 +00:00
Commented Mar 9, 2020 at 18:38 — Antoine L
– Antoine L, Commented Mar 9, 2020 at 18:38

Richard Garside · Accepted Answer · 2023-01-23 22:01:13Z

74

Answer recommended by Microsoft Azure Collective

You may add the following action prior to deploying the artifacts to azure.

You can specify multiple files and it is supported with wildcard entries too.

The environment variable key must be specified with dot separated heirarchy.

#substitute production appsettings entries to appsettings json file
- name: App Settings Variable Substitution
  uses: microsoft/variable-substitution@v1
  with:
    files: '${{env.DOTNET_ROOT}}/myapp/appsettings.json'
  env:
    ConnectionStrings.Default: ${{ secrets.SOME_CONNECTION_STRING }}
    App.ServerRootAddress: ${{ env.SERVER_ROOT_ADDRESS }}

The above action can be used for xml and yaml file changes too.

edited Jan 23, 2023 at 22:01

Richard Garside

89.5k12 gold badges88 silver badges98 bronze badges

answered Mar 29, 2020 at 11:22

Mahi

7586 silver badges5 bronze badges

Sign up to request clarification or add additional context in comments.

11 Comments

Sam Over a year ago

This answer should be ranked higher, and works very well. Particularly with AppSettings values (use AppSettings.MySecret, instead of AppSettings:MySecret). Thank you!

hubert17 Over a year ago

How do we change the attribute of an xml element? Ex: <rule name="ToWwwHttps" enabled="false" stopProcessing="true"> I need to set enabled="true". Thanks for your reply.

Alex Albu Over a year ago

Secrets in Github er case sensitive and they seem to be saved in upper case. You have to have it like this: ${{ secrets.MYCONNSTR }}

Adam Diament Over a year ago

For some reason I could only get it to find my file by specifying '**/appsettings.json', including any other part of the older structure caused a file not found error

Alex 75 Over a year ago

I have my JSON property to replace with spaces and colon in the name, like { "MongoDB:connection string": "replace in Octopus" }. How can I use it in the env? There is a way to escape spaces and/or colon?

|

Collectives™ on Stack Overflow

Change variables in appsettings when deploying with github actions

1 Answer 1

11 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

11 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related