@@ -213,34 +213,31 @@ You can use an existing org for the metadata describe portion of the script by
213
213
214
214
## Prerequisites
215
215
216
- 1. A sfdx project must exist in local.
217
- `sf project generate --name <projectname> --default-package-dir <directory> -x`
218
- 2. An authorized devhub org must exists
219
- `sf org login web -a <alias> -r <localhost url> -d`
220
- 3. A scratch org must exists with alias `registryBuilder`
221
- 1. Update `project-scratch-def.json` as per your requirements.
222
- 2. `sf org create scratch -f config/project-scratch-def.json -a registryBuilder -d`
216
+ 1 . A sfdx project must exist in local ` sf project generate --name <projectname> --default-package-dir <directory> -x `
217
+ 1 . An authorized devhub org must exists ` sf org login web -a <alias> -r <localhost url> -d `
218
+ 1 . A scratch org must exists with alias ` registryBuilder `
219
+ 1 . Update ` project-scratch-def.json ` as per your requirements
220
+ 1 . Run ` sf org create scratch -f config/project-scratch-def.json -a registryBuilder -d `
223
221
224
222
## Steps
225
223
226
- 1. Fork SourceDeployRetrieve github repo
227
- (https://github.com/forcedotcom/source-deploy-retrieve)
228
- 2. Clone forked repo in local and checkout a new branch
229
- 3. Setup Yarn
230
- 1. Go to the repo directory
231
- 2. Run `yarn install && yarn build`
232
- 4. Setup an environment variable by executing command
233
- `export RB_EXISTING_ORG=true`
234
- 5. Execute yarn update command for required metadata entities
235
- `yarn update-registry <MetadataEntity1> <MetadataEntity2>`
236
- 6. Check if respective file(`src/registry/metadataRegistry.json`)
237
- got updated. `git status`
238
-
239
- Now changes are available in local, we have to link the registry with sfdx project
240
-
241
- 8. From SDR git repo directory, run `yarn build; yarn link`
242
- 9. Clone plugin repo (https://github.com/salesforcecli/plugin-deploy-retrieve)
243
- 10. Execute `yarn link @salesforce/source-deploy-retrieve` and `sfdx plugins:link .` and `yarn build` from cloned plugin repo directory
244
-
245
- Registry has been set for your entities, now you can run (e.g.) `sf project deploy start` command for your entities:
246
- Proceed to `Manual Testing` section above in this document.
224
+ 1 . Fork [ SourceDeployRetrieve github repo] ( https://github.com/forcedotcom/source-deploy-retrieve )
225
+ 1 . Clone forked repo in local and checkout a new branch
226
+ 1 . Setup Yarn
227
+ 1 . Go to the repo directory
228
+ 1 . Run ` yarn install && yarn build `
229
+ 1 . Setup an environment variable by executing command ` export RB_EXISTING_ORG=true `
230
+ 1 . Execute yarn update command for required metadata entities ` yarn update-registry <MetadataEntity1> <MetadataEntity2> `
231
+ 1 . Check if respective file (` src/registry/metadataRegistry.json ` ) was updated with ` git status `
232
+
233
+ Now changes are available in local, we have to link the registry with sfdx project
234
+
235
+ 1 . From SDR git repo directory, run ` yarn build && yarn link `
236
+ 1 . Clone the [ plugin-deploy-retrieve repo] ( https://github.com/salesforcecli/plugin-deploy-retrieve )
237
+ 1 . From cloned plugin repo directory execute
238
+ 1 . ` yarn link @salesforce/source-deploy-retrieve `
239
+ 1 . ` sfdx plugins:link . `
240
+ 1 . ` yarn build `
241
+
242
+ Registry has been set for your entities, now you can run (e.g.) ` sf project deploy start ` command for your entities:
243
+ Proceed to ` Manual Testing ` section above in this document.
0 commit comments