Skip to content

Commit d5beeda

Browse files
authored
Merge pull request #7002 from mattbrailsford/uc-deploy-ignore-settings
Add docs on Ignoring Settings for Umbraco Commerce Deploy
2 parents 152b5ee + d086b07 commit d5beeda

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

commerce-add-ons/packages/deploy/deploying-changes.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,35 @@ After installing Umbraco Commerce Deploy, it will automatically serialize any ch
1111
These files should be committed to your repository. Umbraco Deploy will then monitor these files and automatically deploy changes between environments for you.
1212

1313
Learn more about how the deployment process works in the [Umbraco Deploy documentation](https://docs.umbraco.com/umbraco-deploy/).
14+
15+
## Ignoring Settings
16+
17+
Some entities in Umbraco Commerce accept configuration settings such as Payment Methods, Shipping Methods, and Tax Calculation Methods. These settings can be environment-specific, and therefore, you may not want to deploy them between environments. To prevent this from happening, you can add the following configuration options to your `appsettings.json` file.
18+
19+
{% code title="appsettings.json" %}
20+
21+
```json
22+
{
23+
...
24+
"Umbraco": {
25+
"Commerce": {
26+
"Deploy": {
27+
"PaymentMethods": {
28+
"IgnoreSettings": [ "liveApiKey", "testMode" ]
29+
},
30+
"ShippingMethods": {
31+
"IgnoreSettings": [ "liveApiKey", "testMode" ]
32+
},
33+
"TaxCalculationMethods": {
34+
"IgnoreSettings": [ "liveApiKey", "testMode" ]
35+
}
36+
}
37+
}
38+
}
39+
...
40+
}
41+
```
42+
43+
{% encode %}
44+
45+
For each supported entity type, you can supply an `IgnoreSettings` option, which contains an array of aliases of the settings options to be ignored.

0 commit comments

Comments
 (0)