@salesforce/lds-core-release 1.227.2 → 1.228.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +41 -5
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -11,12 +11,48 @@ It's really simple, just run `yarn release:python` from this package, then use t
11
11
 
12
12
  ## Running a release on a Salesforce workspace
13
13
 
14
- This part assumes you have a Salesforce workspace available, and using the **Core on Git** Workspace template. This script does not handle p4 commands.
14
+ This part assumes you have a [Salesforce workspace available](https://sfdc.co/ws), and using the **Core on Git** Workspace template. This script does not handle p4 commands.
15
15
 
16
16
  1. `cd` out of the core path to something like `/opt/workspace`. Make a working directory for yourself here. `mkdir lds`, and `cd` into it.. `cd lds`
17
- 2. Authenticate to Github.com via the installed github cli. `gh auth login`. Make sure you're logged into your EMU account.
17
+ 2. Authenticate to Github.com via the installed github cli. `gh auth login`. Make sure you're logged into your EMU account. Specify that HTTPS is fine for git operations. You'll have to paste an auth code to login.
18
18
  3. Download the release artifact for the version you're trying to release. `gh release download {release version} --repo=salesforce-experience-platform-emu/lds-lightning-platform`
19
- 4. Run the release script that is included in the artifact. `python3 output/lds/release.py`
20
- - Answer the prompts
19
+ 4. Unzip the release artifact. `unzip sfdc.zip`
20
+ 5. Run the release script that is included in the artifact. `python3 output/lds/release.py`
21
+
22
+ - Answer the prompts to point the script to the right directories. To clarify, this is the `sfdc` directory in the unzipped dir.
23
+
24
+ ```
25
+ python output/lds/release.py
26
+ Enter the location of the LDS release artifact. Default: ../../output/sfdc: ./output/sfdc
27
+ Enter the core filepath. Default: /Users/scarraway/repositories/salesforce/core/core-public/core: /opt/workspace/core-public/core
28
+ Source filepath: output/sfdc
29
+ ```
30
+
21
31
  - Validate the changes look correct
22
- 5. Create a branch with all the changes and submit for review.
32
+
33
+ 6. Create a branch with all the changes and submit for review.
34
+
35
+ ## Troubleshooting
36
+
37
+ If you see an error with Git LFS when pushing, you may need to force another change to get LFS up to date.
38
+ Example:
39
+
40
+ ```
41
+ Spawned process 5149 to upload telemetry. Logs at /opt/workspace/gimlet-home/logs/20230712141414/telemetry-upload.nohup.out
42
+ Your token to access the Git-lfs instance (https://gitlfs.soma.salesforce.com/artifactory/api/lfs/gitlfs-coreapp) is valid.
43
+ Preparing lfs
44
+ Git LFS upload failed: 33% (1/3), 4.6 KB | 0 B/s
45
+ (missing) core/ui-force-components/modules/force/ldsAdaptersUiapi/ldsAdaptersUiapi.js (06dcf9a38c6a94e13f9d687b215f3a55d2243df2e2cf19b4464eac964e2824f2)
46
+ (missing) core/ui-force-components/modules/force/ldsAdaptersAnalyticsWave/ldsAdaptersAnalyticsWave.js (9479f6181b61748b5a1256d9df726746df8982f5486043cb81d0b08408fac0bc)
47
+ hint: Your push was rejected due to missing or corrupt local objects.
48
+ hint: You can disable this check with: `git config lfs.allowincompletepush true`
49
+ Uploading LFS objects: 33% (1/3), 4.6 KB | 0 B/s, done.
50
+ error: failed to push some refs to 'https://gitcore.soma.salesforce.com/core-2206/core-public.git'
51
+ ```
52
+
53
+ **CAUTION** Do NOT run `git config lfs.allowincompletepush true`. It can lead to NPE when core-on-git is building your branch.
54
+
55
+ Instead you can
56
+
57
+ 1. Make a whitespace change and re-push those files to your branch.
58
+ 2. Use `git lfs pull --include ui-force-components/modules/force/ldsAdaptersAnalyticsWave/ldsAdaptersAnalyticsWave.js` for each file complained about above. This forces your local git to pull down the LFS files. Then make a whitespace change and re-push.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@salesforce/lds-core-release",
3
3
  "private": false,
4
- "version": "1.227.2",
4
+ "version": "1.228.0",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "description": "LDS release System",
7
7
  "scripts": {