Cannot use Metadata API to deploy a new custom label and label reference in an existing Lightning web component in a single deploy
Trailblazer Community

Cannot use Metadata API to deploy a new custom label and label reference in an existing Lightning web component in a single deploy

API , Metadata , Lightning , Salesforce DX

Last updated 2021-05-26 ·Reference W-7946606 ·Reported By 56 users

Fixed - Summer '21

If you have an org with a lightning web component, and you use Metadata API or sfdx to try to deploy a new custom label and a reference to that custom label in the existing component, you get an error saying that the reference to the custom label is invalid.

1. On your computer, create a new sfdx local project directory, and create a new scratch org.
2. In the scratch org, create a new custom label named CustomLabel1. Run force:source:pull to pull the label file to the local sfdx project source.
3. In the local project, create a new Lightning Web Component. I named mine "showCustomLabel". The component should import the label file and display the label in html (see example source below).
4. Push the source to the scratch org.
5. In the local project, create a new custom label in the same custom label file. Name it CustomLabel2.
6. In the local project, update the showCustomLabel cmp to reference CustomLabel2.
7. Push the source to the scratch org
8. Expected outcome: You can successfully push all the changes.

Actual outcome: Error message: Invalid reference c.customLabel2 of type label in file showCustomLabel.js

Here is source for repro.

You can deploy these files as is for steps 1-4, then uncomment the commented lines and push again for steps 5-7.


<!-- <lightning-card>
</lightning-card> -->

// showCustomLabel.js

import { LightningElement } from 'lwc';
import CUSTOM_LABEL_1 from '@salesforce/label/c.customLabel1';
// import CUSTOM_LABEL_2 from '@salesforce/label/c.customLabel2';

export default class ShowCustomLabel extends LightningElement {
label = {

<?xml version="1.0" encoding="UTF-8"?>
<CustomLabels xmlns="">
<value>This is the first label created.</value>

<!-- <labels>

<value>This is the second label created.</value>
</labels> -->

The workaround is to push the label first, then push the reference to it in the component, but this workaround is not obvious to new developers, and is not obvious from the error message.

Is it Fixed?

AP0 AP3 AP4 AP5 AP6 AP7 AP8 AP9 AP10 AP11 AP12 AP13 AP14 AP15 AP16 AP17 AP18 AP19 AP20 AP21 AP22 AP24 AP25 AP26 AP27 AP28 AUS1 AUS11 AUS23 AUS26S AUS24S AUS22S AUS2S AUS27 AUS25 AUS3 AUS43 AUS4S AUS5 AUS6S AUS7 AUS9 BRA1 BRA2S BRA4S CAN1 CAN17 CAN11 CAN2S CAN4S CAN6S CAN8S CS1 CS2 CS4 CS5 CS6 CS7 CS8 CS9 CS10 CS109 CS108 CS107 CS106 CS105 CS102 CS101 CS100 CS115 CS119 CS110 CS117 CS114 CS113 CS112 CS111 CS11 CS116 CS123 CS122 CS121 CS126 CS127 CS129 CS128 CS125 CS124 CS137 CS138 CS133 CS132 CS14 CS148 CS142 CS159 CS152 CS151 CS15 CS162 CS167 CS166 CS16 CS169 CS165 CS160 CS173 CS17 CS172 CS170 CS171 CS174 CS18 CS189 CS194 CS192 CS193 CS190 CS191 CS199 CS197 CS19 CS198 CS196 CS195 CS20 CS209 CS200 CS202 CS201 CS203 CS21 CS219 CS218 CS217 CS216 CS215 CS214 CS213 CS212 CS211 CS210 CS22 CS220 CS23 CS234 CS24 CS25 CS26 CS27 CS28 CS29 CS31 CS32 CS33 CS34 CS35 CS36 CS37 CS40 CS41 CS42 CS43 CS44 CS45 CS47 CS53 CS57 CS58 CS59 CS60 CS61 CS62 CS63 CS64 CS65 CS66 CS67 CS68 CS69 CS72 CS73 CS74 CS75 CS76 CS77 CS78 CS79 CS80 CS81 CS84 CS86 CS87 CS88 CS89 CS90 CS91 CS92 CS94 CS95 CS96 CS97 CS98 CS99 DEU1 DEU2S DEU4S EU16 EU17 EU18 EU19 EU25 EU26 EU27 EU28 EU29 EU30 EU31 EU32 EU33 EU34 EU35 EU36 EU37 EU38 EU39 EU40 EU41 EU42 EU43 EU44 EU45 EU46 EU47 EU48 FRA1 FRA2S FRA4S IND1 IND18S IND16S IND15 IND13 IND11 IND23 IND2S IND3S IND4S IND5 IND6S IND7 IND9 JPN1 JPN12S JPN10S JPN2S JPN3 JPN4S JPN5 JPN6S JPN7 JPN8S NA104 NA107 NA109 NA100 NA101 NA103 NA102 NA105 NA119 NA116 NA110 NA118 NA112 NA111 NA115 NA114 NA113 NA117 NA125 NA124 NA122 NA120 NA126 NA127 NA123 NA129 NA121 NA128 NA138 NA134 NA133 NA136 NA135 NA132 NA131 NA130 NA137 NA139 NA140 NA142 NA141 NA149 NA146 NA147 NA148 NA154 NA158 NA159 NA153 NA151 NA155 NA152 NA150 NA156 NA161 NA163 NA167 NA160 NA166 NA165 NA169 NA164 NA168 NA162 NA172 NA170 NA174 NA171 NA173 NA196 NA207 NA204 NA206 NA208 NA209 NA21 NA218 NA214 NA217 NA215 NA211 NA212 NA213 NA210 NA65 NA70 NA71 NA75 NA80 NA81 NA82 NA83 NA84 NA85 NA89 NA90 NA91 NA92 NA93 NA94 NA95 NA96 NA97 NA98 NA99 SGP2S SGP4S UM1 UM2 UM3 UM4 UM5 UM6 UM7 UM8 UM9 USA1 USA18S USA16S USA10S USA2S USA3S USA7 USA8S

Any unreleased services, features, statuses, or dates referenced in this or other public statements are not currently available and may not be delivered on time or at all. Customers who purchase our services should make their purchase decisions based upon features that are currently available.