Skip to content
This repository was archived by the owner on Jan 28, 2024. It is now read-only.

Commit 59d6b76

Browse files
authored
Update README.md
1 parent 869ce4a commit 59d6b76

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Heroku Buildpack for Salesforce
22

33
This is the official [Heroku buildpack](http://devcenter.heroku.com/articles/buildpacks) for Salesforce apps.
4-
This buildpack enables various Salesforce specific development operations such as creating scratch orgs and pushing source, creating and installing Unlocked Packages, running Apex unit tests, and deploying metadata.
4+
This buildpack enables various Salesforce specific development operations such as creating scratch orgs and pushing source, creating and installing Unlocked Packages, running Apex unit tests, and deploying metadata. It uses [https://github.com/heroku/salesforce-cli-buildpack](https://github.com/heroku/salesforce-cli-buildpack) to download and setup the Salesforce CLI and jq.
55

6-
Below you'll find information on the **requirements** in your Salesforce project repository, the **config vars** required to operate the buildpack.
6+
Below you'll find information on the **requirements** in your Salesforce project repository and the **config vars** required to operate the buildpack. To painlessly setup your Heroku Pipeline, use this [setup script](https://github.com/heroku/salesforce-buildpack/blob/master/scripts/setup.sh).
77

8-
To see an example Salesforce project that's configured to use Heroku Pipelines and CI, see [https://github.com/wadewegner/salesforce-dx-pipeline-sample](https://github.com/wadewegner/salesforce-dx-pipeline-sample). It's also worth noting that this buildpack is dependent on [https://github.com/heroku/salesforce-cli-buildpack](https://github.com/heroku/salesforce-cli-buildpack), which installs the Salesforce CLI into the underlying dyno.
8+
To see an example Salesforce project that's configured to use Heroku Pipelines and CI, see [salesforce-dx-pipeline-sample](https://github.com/wadewegner/salesforce-dx-pipeline-sample).
99

1010
## Requirements
1111

@@ -20,7 +20,7 @@ This buildpack requires the following to be present in the Salesforce app reposi
2020
"url": "https://github.com/heroku/salesforce-cli-buildpack#v3"
2121
},
2222
{
23-
"url": "https://github.com/heroku/salesforce-buildpack#v1"
23+
"url": "https://github.com/heroku/salesforce-buildpack#v2"
2424
}
2525
```
2626
@@ -107,7 +107,7 @@ Note: Typically the development stage is the parent to review apps, so these con
107107
108108
- `SFDX_BUILDPACK_DEBUG=true`: Instructs the buildpack to display debug information.
109109
110-
- `SFDX_DEV_HUB_AUTH_URL`: Provides credentials to the buildpack for connecting to the Dev Hub (used for creating a scratch org). You can get this value by running `sfdx force:org:display --verbose --json` against your Dev Hub and grabbing the `sfdxAuthUrl`.
110+
- `SFDX_DEV_HUB_AUTH_URL`: Provides credentials to the buildpack for connecting to the Dev Hub. You can get this value by running `sfdx force:org:display --verbose --json` against your Dev Hub and grabbing the `sfdxAuthUrl`.
111111
112112
- `SFDX_AUTH_URL`: Provides credentials to the buildpack for connecting to the org used by Development (typically a dev integration environment). You can get this value by running `sfdx force:org:display --verbose --json` against your org and grabbing the `sfdxAuthUrl`.
113113
@@ -119,6 +119,8 @@ These values are the same as above but with the following considerations.
119119
120120
- `SFDX_CREATE_PACKAGE_VERSION=false`: Typically you don't want to create a new package version at each stage. So this value should be false.
121121
122+
- `SFDX_DEV_HUB_AUTH_URL`: Provides credentials to the buildpack for connecting to the Dev Hub. You can get this value by running `sfdx force:org:display --verbose --json` against your Dev Hub and grabbing the `sfdxAuthUrl`.
123+
122124
- `SFDX_AUTH_URL`: This should map to your staging environment, typically a full sandbox.
123125
124126
### Production
@@ -127,4 +129,6 @@ These values are the same as above but with the following considerations.
127129
128130
- `STAGE=PROD`: Instructs the buildpack that this app stage is PROD.
129131
132+
- `SFDX_DEV_HUB_AUTH_URL`: Provides credentials to the buildpack for connecting to the Dev Hub. You can get this value by running `sfdx force:org:display --verbose --json` against your Dev Hub and grabbing the `sfdxAuthUrl`.
133+
130134
- `SFDX_AUTH_URL`: This should map to your production environment.

0 commit comments

Comments
 (0)