You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 28, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+9-5Lines changed: 9 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
1
# Heroku Buildpack for Salesforce
2
2
3
3
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.
5
5
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).
7
7
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).
9
9
10
10
## Requirements
11
11
@@ -20,7 +20,7 @@ This buildpack requires the following to be present in the Salesforce app reposi
@@ -107,7 +107,7 @@ Note: Typically the development stage is the parent to review apps, so these con
107
107
108
108
- `SFDX_BUILDPACK_DEBUG=true`: Instructs the buildpack to display debug information.
109
109
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`.
111
111
112
112
- `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`.
113
113
@@ -119,6 +119,8 @@ These values are the same as above but with the following considerations.
119
119
120
120
- `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.
121
121
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
+
122
124
- `SFDX_AUTH_URL`: This should map to your staging environment, typically a full sandbox.
123
125
124
126
### Production
@@ -127,4 +129,6 @@ These values are the same as above but with the following considerations.
127
129
128
130
- `STAGE=PROD`: Instructs the buildpack that this app stage is PROD.
129
131
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
+
130
134
- `SFDX_AUTH_URL`: This should map to your production environment.
0 commit comments