Skip to content

Commit fd8a11f

Browse files
paynecrl97paynecrl97
authored
Updates env var prefix
1 parent 3bbb181 commit fd8a11f

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

‎content/reference/configuration.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ Control the way that OrgFlow interacts with Git.
1717

1818
| Environment Variable | Command Option | Description | Default Value |
1919
| ----------------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -------------------------- |
20-
| `ORGFLOW_GIT__EXECUTABLEPATH` | `--c:git:executablePath` | The location of the Git executable on disk. | `git` |
21-
| `ORGFLOW_GIT__UNKNOWNAUTHORNAME` | `--c:git:unknownAuthorName` | The name to use in the commit signature for changes where OrgFlow is unable to determine the author (for example, deletes). | `Unknown Author` |
22-
| `ORGFLOW_GIT__UNKNOWNAUTHOREMAIL` | `--c:git:unknownAuthorEmail` | The email address to use in the commit signature for changes where OrgFlow is unable to determine the author (for example, deletes). | `unknownauthor@orgflow.io` |
23-
| `ORGFLOW_GIT__COMMITTERNAME` | `--c:git:committerName` | The name to use in the committer's commit signature. | `OrgFlow` |
24-
| `ORGFLOW_GIT__COMMITTEREMAIL` | `--c:git:committerEmail` | The email address to use in the committer's commit signature. | `orgflow@orgflow.io` |
25-
| `ORGFLOW_GIT__MERGESTRATEGY` | `--c:git:mergeStrategy` | The [merge strategy option](https://git-scm.com/docs/git-merge#Documentation/git-merge.txt--sltstrategygt) passed to Git. | `recursive` |
26-
| `ORGFLOW_GIT__MERGESTRATEGYOPTIONS` | `--c:git:mergeStrategyOptions` | The [merge strategy specific options](https://git-scm.com/docs/git-merge#Documentation/git-merge.txt--Xltoptiongt) passed to Git. | `diff-algorithm=patience` |
20+
| `ORGFLOW__GIT__EXECUTABLEPATH` | `--c:git:executablePath` | The location of the Git executable on disk. | `git` |
21+
| `ORGFLOW__GIT__UNKNOWNAUTHORNAME` | `--c:git:unknownAuthorName` | The name to use in the commit signature for changes where OrgFlow is unable to determine the author (for example, deletes). | `Unknown Author` |
22+
| `ORGFLOW__GIT__UNKNOWNAUTHOREMAIL` | `--c:git:unknownAuthorEmail` | The email address to use in the commit signature for changes where OrgFlow is unable to determine the author (for example, deletes). | `unknownauthor@orgflow.io` |
23+
| `ORGFLOW__GIT__COMMITTERNAME` | `--c:git:committerName` | The name to use in the committer's commit signature. | `OrgFlow` |
24+
| `ORGFLOW__GIT__COMMITTEREMAIL` | `--c:git:committerEmail` | The email address to use in the committer's commit signature. | `orgflow@orgflow.io` |
25+
| `ORGFLOW__GIT__MERGESTRATEGY` | `--c:git:mergeStrategy` | The [merge strategy option](https://git-scm.com/docs/git-merge#Documentation/git-merge.txt--sltstrategygt) passed to Git. | `recursive` |
26+
| `ORGFLOW__GIT__MERGESTRATEGYOPTIONS` | `--c:git:mergeStrategyOptions` | The [merge strategy specific options](https://git-scm.com/docs/git-merge#Documentation/git-merge.txt--Xltoptiongt) passed to Git. | `diff-algorithm=patience` |
2727

2828
### Metadata API
2929

@@ -33,18 +33,18 @@ This includes options to change how many metadata items are included in a single
3333

3434
| Environment Variable | Command Option | Description | Default Value |
3535
| ----------------------------------------------------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
36-
| `ORGFLOW_METADATAPI__MAXNUMBERCONCURRENTLISTCALLS` | `--c:metadataapi:maxnumberconcurrentlistcalls` | The maximum number of concurrent API calls to Salesforce's metadata list API endpoint. | `8` |
37-
| `ORGFLOW_METADATAPI__MAXNUMBERCONCURRENTRETRIEVEOPERATIONS` | `--c:metadataapi:maxnumberconcurrentretrieveoperations` | The maximum number of retrieve batches to be concurrently retrieved from Salesforce's metadata retrieve API. | `16` |
38-
| `ORGFLOW_METADATAPI__MINRETRIEVEBATCHSIZE` | `--c:metadataapi:minretrievebatchsize` | The minimum number of metadata items that OrgFlow should aim to include in each retrieve batch. | `200` |
39-
| `ORGFLOW_METADATAPI__MAXRETRIEVEBATCHSIZE` | `--c:metadataapi:maxretrievebatchsize` | The maximum number of metadata items that OrgFlow should aim to include in each retrieve batch. | `1000` |
40-
| `ORGFLOW_METADATAPI__MINNUMBERRETRIEVEBATCHES` | `--c:metadataapi:minnumberretrievebatches` | The minimum number of retrieve batches that OrgFlow should aim to create. This value does not impact the minimum number of metadata items that OrgFlow should aim to include in each retrieve batch, but it can impact the maximum number of metadata items that OrgFlow should aim to include in each retrieve batch. For example, if there aren't enough metadata items to fill each batch, OrgFlow will lower the maximum number of metadata items in each batch in order to try and hit the minimum number of retrieve batches target. However, if there aren't enough metadata items to hit the minimum number of retrieve batches target, then OrgFlow will favor reducing the number of batches that it creates as opposed to lowering the minimum number of metadata items that OrgFlow should aim to include in each retrieve batch. | `16` |
36+
| `ORGFLOW__METADATAPI__MAXNUMBERCONCURRENTLISTCALLS` | `--c:metadataapi:maxnumberconcurrentlistcalls` | The maximum number of concurrent API calls to Salesforce's metadata list API endpoint. | `8` |
37+
| `ORGFLOW__METADATAPI__MAXNUMBERCONCURRENTRETRIEVEOPERATIONS` | `--c:metadataapi:maxnumberconcurrentretrieveoperations` | The maximum number of retrieve batches to be concurrently retrieved from Salesforce's metadata retrieve API. | `16` |
38+
| `ORGFLOW__METADATAPI__MINRETRIEVEBATCHSIZE` | `--c:metadataapi:minretrievebatchsize` | The minimum number of metadata items that OrgFlow should aim to include in each retrieve batch. | `200` |
39+
| `ORGFLOW__METADATAPI__MAXRETRIEVEBATCHSIZE` | `--c:metadataapi:maxretrievebatchsize` | The maximum number of metadata items that OrgFlow should aim to include in each retrieve batch. | `1000` |
40+
| `ORGFLOW__METADATAPI__MINNUMBERRETRIEVEBATCHES` | `--c:metadataapi:minnumberretrievebatches` | The minimum number of retrieve batches that OrgFlow should aim to create. This value does not impact the minimum number of metadata items that OrgFlow should aim to include in each retrieve batch, but it can impact the maximum number of metadata items that OrgFlow should aim to include in each retrieve batch. For example, if there aren't enough metadata items to fill each batch, OrgFlow will lower the maximum number of metadata items in each batch in order to try and hit the minimum number of retrieve batches target. However, if there aren't enough metadata items to hit the minimum number of retrieve batches target, then OrgFlow will favor reducing the number of batches that it creates as opposed to lowering the minimum number of metadata items that OrgFlow should aim to include in each retrieve batch. | `16` |
4141
| `ORGFLOW_METADATAPI__MAXDEPENDENTSBATCHUTILIZATIONPERCENT` | `--c:metadataapi:maxdependentsbatchutilizationpercent` | Metadata items such as Profiles (which depend on CustomObjects, CustomTabs, and ApexClasses among others) and Translations (which depend on CustomLabels, CustomTabs, and QuickActions among others) can be included in more than one batch because they need to be retrieved in that same batches as their dependencies. This value aims to reduce the duplication of these items between batches by increasing the maximum number of metadata items that OrgFlow should aim to include in each retrieve batch if the number of dependent items is too large compared to their dependencies. For example: if the target retrieve batch size is 1,000 items, a batch contains 600 Profiles, and this value is set to 50%, then OrgFlow will add more items to the retrieve batch to in order to ensure that the retrieve batch is made up of no more than 50% Profiles (i.e. OrgFlow will aim to put 1,200 items in this batch). | `50` |
4242

4343
### Metadata Archives
4444

4545
| Environment Variable | Command Option | Description | Default Value |
4646
| ------------------------------------------------- | --------------------------------------------- | --------------------------------------------------------------------------------- | ------------- |
47-
| `ORGFLOW_METADATARCHIVE__DISALLOWCASEONLYRENAMES` | `--c:metadataarchive:disallowcaseonlyrenames` | Whether or not OrgFlow will allow case-ony renames of metadata files<sup>1</sup>. | `true` |
47+
| `ORGFLOW__METADATARCHIVE__DISALLOWCASEONLYRENAMES` | `--c:metadataarchive:disallowcaseonlyrenames` | Whether or not OrgFlow will allow case-ony renames of metadata files<sup>1</sup>. | `true` |
4848

4949
#### Notes
5050

0 commit comments

Comments
 (0)