@salesforce/plugin-devops-center 2.3.4 → 2.3.6
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.
- package/README.md +31 -31
- package/oclif.manifest.json +557 -557
- package/package.json +4 -4
package/oclif.manifest.json
CHANGED
|
@@ -1480,13 +1480,12 @@
|
|
|
1480
1480
|
"update.js"
|
|
1481
1481
|
]
|
|
1482
1482
|
},
|
|
1483
|
-
"
|
|
1483
|
+
"devops:pipeline:project:add": {
|
|
1484
1484
|
"aliases": [],
|
|
1485
1485
|
"args": {},
|
|
1486
|
-
"description": "
|
|
1486
|
+
"description": "You can attach a project to only one pipeline.",
|
|
1487
1487
|
"examples": [
|
|
1488
|
-
"
|
|
1489
|
-
"Asynchronously run a quick deploy of the most recently validated deployment using an org with alias \"my-prod-org\":\n<%= config.bin %> <%= command.id %> --async --use-most-recent --devops-center-username my-prod-org"
|
|
1488
|
+
"Attach a project to a pipeline using the project ID and pipeline ID.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --project-id 0Hn000000000001"
|
|
1490
1489
|
],
|
|
1491
1490
|
"flags": {
|
|
1492
1491
|
"json": {
|
|
@@ -1504,96 +1503,65 @@
|
|
|
1504
1503
|
"multiple": false,
|
|
1505
1504
|
"type": "option"
|
|
1506
1505
|
},
|
|
1507
|
-
"
|
|
1508
|
-
"
|
|
1509
|
-
"name": "
|
|
1510
|
-
"
|
|
1511
|
-
"
|
|
1512
|
-
"
|
|
1513
|
-
},
|
|
1514
|
-
"concise": {
|
|
1515
|
-
"exclusive": [
|
|
1516
|
-
"verbose"
|
|
1517
|
-
],
|
|
1518
|
-
"name": "concise",
|
|
1519
|
-
"summary": "Show concise output of the command result.",
|
|
1520
|
-
"allowNo": false,
|
|
1521
|
-
"type": "boolean"
|
|
1522
|
-
},
|
|
1523
|
-
"verbose": {
|
|
1524
|
-
"name": "verbose",
|
|
1525
|
-
"summary": "Show verbose output of the command result.",
|
|
1526
|
-
"allowNo": false,
|
|
1527
|
-
"type": "boolean"
|
|
1528
|
-
},
|
|
1529
|
-
"wait": {
|
|
1530
|
-
"char": "w",
|
|
1531
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"sf project deploy pipeline report\".",
|
|
1532
|
-
"exclusive": [
|
|
1533
|
-
"async"
|
|
1534
|
-
],
|
|
1535
|
-
"name": "wait",
|
|
1536
|
-
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1537
|
-
"default": "33 minutes",
|
|
1506
|
+
"target-org": {
|
|
1507
|
+
"char": "o",
|
|
1508
|
+
"name": "target-org",
|
|
1509
|
+
"noCacheDefault": true,
|
|
1510
|
+
"required": true,
|
|
1511
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1538
1512
|
"hasDynamicHelp": true,
|
|
1539
|
-
"helpValue": "<minutes>",
|
|
1540
1513
|
"multiple": false,
|
|
1541
1514
|
"type": "option"
|
|
1542
1515
|
},
|
|
1543
|
-
"
|
|
1544
|
-
"
|
|
1545
|
-
"name": "
|
|
1546
|
-
"
|
|
1547
|
-
"summary": "Username or alias of the DevOps Center org.",
|
|
1548
|
-
"hasDynamicHelp": true,
|
|
1516
|
+
"api-version": {
|
|
1517
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1518
|
+
"name": "api-version",
|
|
1519
|
+
"hasDynamicHelp": false,
|
|
1549
1520
|
"multiple": false,
|
|
1550
1521
|
"type": "option"
|
|
1551
1522
|
},
|
|
1552
|
-
"
|
|
1553
|
-
"
|
|
1554
|
-
"
|
|
1555
|
-
"
|
|
1556
|
-
"summary": "Job ID of the validated deployment to quick deploy.",
|
|
1523
|
+
"pipeline-id": {
|
|
1524
|
+
"name": "pipeline-id",
|
|
1525
|
+
"required": true,
|
|
1526
|
+
"summary": "ID of the pipeline.",
|
|
1557
1527
|
"hasDynamicHelp": false,
|
|
1558
1528
|
"multiple": false,
|
|
1559
1529
|
"type": "option"
|
|
1560
1530
|
},
|
|
1561
|
-
"
|
|
1562
|
-
"
|
|
1563
|
-
"
|
|
1564
|
-
"
|
|
1565
|
-
"
|
|
1566
|
-
"
|
|
1567
|
-
"type": "
|
|
1531
|
+
"project-id": {
|
|
1532
|
+
"name": "project-id",
|
|
1533
|
+
"required": true,
|
|
1534
|
+
"summary": "ID of the DevOps Center project.",
|
|
1535
|
+
"hasDynamicHelp": false,
|
|
1536
|
+
"multiple": false,
|
|
1537
|
+
"type": "option"
|
|
1568
1538
|
}
|
|
1569
1539
|
},
|
|
1570
1540
|
"hasDynamicHelp": true,
|
|
1571
1541
|
"hiddenAliases": [],
|
|
1572
|
-
"id": "
|
|
1542
|
+
"id": "devops:pipeline:project:add",
|
|
1573
1543
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
1574
1544
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
1575
1545
|
"pluginType": "core",
|
|
1576
|
-
"state": "beta",
|
|
1577
1546
|
"strict": true,
|
|
1578
|
-
"summary": "
|
|
1547
|
+
"summary": "Attach a DevOps Center project to a pipeline.",
|
|
1579
1548
|
"enableJsonFlag": true,
|
|
1580
1549
|
"isESM": true,
|
|
1581
1550
|
"relativePath": [
|
|
1582
1551
|
"lib",
|
|
1583
1552
|
"commands",
|
|
1584
|
-
"
|
|
1585
|
-
"deploy",
|
|
1553
|
+
"devops",
|
|
1586
1554
|
"pipeline",
|
|
1587
|
-
"
|
|
1555
|
+
"project",
|
|
1556
|
+
"add.js"
|
|
1588
1557
|
]
|
|
1589
1558
|
},
|
|
1590
|
-
"
|
|
1559
|
+
"devops:pipeline:project:delete": {
|
|
1591
1560
|
"aliases": [],
|
|
1592
1561
|
"args": {},
|
|
1593
|
-
"description": "
|
|
1562
|
+
"description": "Deletes the junction record that connects the project to the pipeline. The project itself is not deleted.",
|
|
1594
1563
|
"examples": [
|
|
1595
|
-
"
|
|
1596
|
-
"Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --devops-center-username MyStagingSandbox --use-most-recent"
|
|
1564
|
+
"Remove a project from a pipeline using the project ID and pipeline ID.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --project-id 0Hn000000000001"
|
|
1597
1565
|
],
|
|
1598
1566
|
"flags": {
|
|
1599
1567
|
"json": {
|
|
@@ -1611,60 +1579,66 @@
|
|
|
1611
1579
|
"multiple": false,
|
|
1612
1580
|
"type": "option"
|
|
1613
1581
|
},
|
|
1614
|
-
"
|
|
1615
|
-
"char": "
|
|
1616
|
-
"name": "
|
|
1582
|
+
"target-org": {
|
|
1583
|
+
"char": "o",
|
|
1584
|
+
"name": "target-org",
|
|
1585
|
+
"noCacheDefault": true,
|
|
1617
1586
|
"required": true,
|
|
1618
|
-
"summary": "Username or alias of the
|
|
1587
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1619
1588
|
"hasDynamicHelp": true,
|
|
1620
1589
|
"multiple": false,
|
|
1621
1590
|
"type": "option"
|
|
1622
1591
|
},
|
|
1623
|
-
"
|
|
1624
|
-
"
|
|
1625
|
-
"
|
|
1626
|
-
"name": "job-id",
|
|
1627
|
-
"summary": "Job ID of the pipeline deployment to check the status of.",
|
|
1592
|
+
"api-version": {
|
|
1593
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1594
|
+
"name": "api-version",
|
|
1628
1595
|
"hasDynamicHelp": false,
|
|
1629
1596
|
"multiple": false,
|
|
1630
1597
|
"type": "option"
|
|
1631
1598
|
},
|
|
1632
|
-
"
|
|
1633
|
-
"
|
|
1634
|
-
"
|
|
1635
|
-
"
|
|
1636
|
-
"
|
|
1637
|
-
"
|
|
1638
|
-
"type": "
|
|
1599
|
+
"pipeline-id": {
|
|
1600
|
+
"name": "pipeline-id",
|
|
1601
|
+
"required": true,
|
|
1602
|
+
"summary": "ID of the pipeline.",
|
|
1603
|
+
"hasDynamicHelp": false,
|
|
1604
|
+
"multiple": false,
|
|
1605
|
+
"type": "option"
|
|
1606
|
+
},
|
|
1607
|
+
"project-id": {
|
|
1608
|
+
"name": "project-id",
|
|
1609
|
+
"required": true,
|
|
1610
|
+
"summary": "ID of the DevOps Center project.",
|
|
1611
|
+
"hasDynamicHelp": false,
|
|
1612
|
+
"multiple": false,
|
|
1613
|
+
"type": "option"
|
|
1639
1614
|
}
|
|
1640
1615
|
},
|
|
1641
1616
|
"hasDynamicHelp": true,
|
|
1642
1617
|
"hiddenAliases": [],
|
|
1643
|
-
"id": "
|
|
1618
|
+
"id": "devops:pipeline:project:delete",
|
|
1644
1619
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
1645
1620
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
1646
1621
|
"pluginType": "core",
|
|
1647
|
-
"state": "beta",
|
|
1648
1622
|
"strict": true,
|
|
1649
|
-
"summary": "
|
|
1623
|
+
"summary": "Remove a DevOps Center project's connection to a pipeline.",
|
|
1650
1624
|
"enableJsonFlag": true,
|
|
1651
1625
|
"isESM": true,
|
|
1652
1626
|
"relativePath": [
|
|
1653
1627
|
"lib",
|
|
1654
1628
|
"commands",
|
|
1655
|
-
"
|
|
1656
|
-
"deploy",
|
|
1629
|
+
"devops",
|
|
1657
1630
|
"pipeline",
|
|
1658
|
-
"
|
|
1631
|
+
"project",
|
|
1632
|
+
"delete.js"
|
|
1659
1633
|
]
|
|
1660
1634
|
},
|
|
1661
|
-
"
|
|
1635
|
+
"devops:pipeline:stage:add": {
|
|
1662
1636
|
"aliases": [],
|
|
1663
1637
|
"args": {},
|
|
1664
|
-
"description": "
|
|
1638
|
+
"description": "Inserts an empty stage before the stage specified by `--next-stage-id`. The new stage doesn't include a branch or environment. Configure them separately after you create the stage.",
|
|
1665
1639
|
"examples": [
|
|
1666
|
-
"
|
|
1667
|
-
"
|
|
1640
|
+
"Add a Development stage before Integration in a specific pipeline.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --name \"Development\" --next-stage-id 0Xc000000000002",
|
|
1641
|
+
"Add a QA stage before UAT in a specific pipeline.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --name \"QA\" --next-stage-id 0Xc000000000003"
|
|
1668
1642
|
],
|
|
1669
1643
|
"flags": {
|
|
1670
1644
|
"json": {
|
|
@@ -1682,89 +1656,74 @@
|
|
|
1682
1656
|
"multiple": false,
|
|
1683
1657
|
"type": "option"
|
|
1684
1658
|
},
|
|
1685
|
-
"
|
|
1686
|
-
"char": "
|
|
1687
|
-
"name": "
|
|
1659
|
+
"target-org": {
|
|
1660
|
+
"char": "o",
|
|
1661
|
+
"name": "target-org",
|
|
1662
|
+
"noCacheDefault": true,
|
|
1688
1663
|
"required": true,
|
|
1689
|
-
"summary": "Username or alias of the
|
|
1664
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1690
1665
|
"hasDynamicHelp": true,
|
|
1691
1666
|
"multiple": false,
|
|
1692
1667
|
"type": "option"
|
|
1693
1668
|
},
|
|
1694
|
-
"
|
|
1695
|
-
"
|
|
1696
|
-
"
|
|
1697
|
-
"name": "job-id",
|
|
1698
|
-
"summary": "Job ID of the pipeline deploy operation you want to resume.",
|
|
1669
|
+
"api-version": {
|
|
1670
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1671
|
+
"name": "api-version",
|
|
1699
1672
|
"hasDynamicHelp": false,
|
|
1700
1673
|
"multiple": false,
|
|
1701
1674
|
"type": "option"
|
|
1702
1675
|
},
|
|
1703
|
-
"
|
|
1704
|
-
"
|
|
1705
|
-
"
|
|
1706
|
-
"
|
|
1707
|
-
"
|
|
1708
|
-
"
|
|
1709
|
-
"type": "
|
|
1710
|
-
},
|
|
1711
|
-
"concise": {
|
|
1712
|
-
"exclusive": [
|
|
1713
|
-
"verbose"
|
|
1714
|
-
],
|
|
1715
|
-
"name": "concise",
|
|
1716
|
-
"summary": "Show concise output of the command result.",
|
|
1717
|
-
"allowNo": false,
|
|
1718
|
-
"type": "boolean"
|
|
1676
|
+
"pipeline-id": {
|
|
1677
|
+
"name": "pipeline-id",
|
|
1678
|
+
"required": true,
|
|
1679
|
+
"summary": "ID of the pipeline where the stage is added.",
|
|
1680
|
+
"hasDynamicHelp": false,
|
|
1681
|
+
"multiple": false,
|
|
1682
|
+
"type": "option"
|
|
1719
1683
|
},
|
|
1720
|
-
"
|
|
1721
|
-
"
|
|
1722
|
-
"
|
|
1723
|
-
"
|
|
1724
|
-
"
|
|
1684
|
+
"name": {
|
|
1685
|
+
"char": "n",
|
|
1686
|
+
"name": "name",
|
|
1687
|
+
"required": true,
|
|
1688
|
+
"summary": "Name of the pipeline stage, such as Integration, UAT, or Staging.",
|
|
1689
|
+
"hasDynamicHelp": false,
|
|
1690
|
+
"multiple": false,
|
|
1691
|
+
"type": "option"
|
|
1725
1692
|
},
|
|
1726
|
-
"
|
|
1727
|
-
"
|
|
1728
|
-
"
|
|
1729
|
-
"
|
|
1730
|
-
|
|
1731
|
-
],
|
|
1732
|
-
"name": "wait",
|
|
1733
|
-
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1734
|
-
"default": "33 minutes",
|
|
1735
|
-
"hasDynamicHelp": true,
|
|
1736
|
-
"helpValue": "<minutes>",
|
|
1693
|
+
"next-stage-id": {
|
|
1694
|
+
"name": "next-stage-id",
|
|
1695
|
+
"required": true,
|
|
1696
|
+
"summary": "ID of the stage that follows the new stage in the pipeline.",
|
|
1697
|
+
"hasDynamicHelp": false,
|
|
1737
1698
|
"multiple": false,
|
|
1738
1699
|
"type": "option"
|
|
1739
1700
|
}
|
|
1740
1701
|
},
|
|
1741
1702
|
"hasDynamicHelp": true,
|
|
1742
1703
|
"hiddenAliases": [],
|
|
1743
|
-
"id": "
|
|
1704
|
+
"id": "devops:pipeline:stage:add",
|
|
1744
1705
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
1745
1706
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
1746
1707
|
"pluginType": "core",
|
|
1747
|
-
"state": "beta",
|
|
1748
1708
|
"strict": true,
|
|
1749
|
-
"summary": "
|
|
1709
|
+
"summary": "Add a stage to a DevOps Center pipeline.",
|
|
1750
1710
|
"enableJsonFlag": true,
|
|
1751
1711
|
"isESM": true,
|
|
1752
1712
|
"relativePath": [
|
|
1753
1713
|
"lib",
|
|
1754
1714
|
"commands",
|
|
1755
|
-
"
|
|
1756
|
-
"deploy",
|
|
1715
|
+
"devops",
|
|
1757
1716
|
"pipeline",
|
|
1758
|
-
"
|
|
1717
|
+
"stage",
|
|
1718
|
+
"add.js"
|
|
1759
1719
|
]
|
|
1760
1720
|
},
|
|
1761
|
-
"
|
|
1721
|
+
"devops:pipeline:stage:delete": {
|
|
1762
1722
|
"aliases": [],
|
|
1763
1723
|
"args": {},
|
|
1764
|
-
"description": "
|
|
1724
|
+
"description": "Deletes the specified stage from the pipeline. If the stage sits between two other stages, the predecessor stage is automatically re-linked to the successor so the pipeline chain stays intact.",
|
|
1765
1725
|
"examples": [
|
|
1766
|
-
"
|
|
1767
|
-
"Deploy all changes in the main branch to the release environment:\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name main --devops-center-username MyReleaseOrg --deploy-all"
|
|
1726
|
+
"Delete a stage from a pipeline:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --stage-id 0Xc000000000002"
|
|
1768
1727
|
],
|
|
1769
1728
|
"flags": {
|
|
1770
1729
|
"json": {
|
|
@@ -1782,138 +1741,65 @@
|
|
|
1782
1741
|
"multiple": false,
|
|
1783
1742
|
"type": "option"
|
|
1784
1743
|
},
|
|
1785
|
-
"
|
|
1786
|
-
"char": "
|
|
1787
|
-
"name": "
|
|
1744
|
+
"target-org": {
|
|
1745
|
+
"char": "o",
|
|
1746
|
+
"name": "target-org",
|
|
1747
|
+
"noCacheDefault": true,
|
|
1788
1748
|
"required": true,
|
|
1789
|
-
"summary": "
|
|
1790
|
-
"hasDynamicHelp":
|
|
1749
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1750
|
+
"hasDynamicHelp": true,
|
|
1791
1751
|
"multiple": false,
|
|
1792
1752
|
"type": "option"
|
|
1793
1753
|
},
|
|
1794
|
-
"
|
|
1795
|
-
"
|
|
1796
|
-
"
|
|
1797
|
-
"name": "bundle-version-name",
|
|
1798
|
-
"summary": "Version name of the bundle.",
|
|
1754
|
+
"api-version": {
|
|
1755
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1756
|
+
"name": "api-version",
|
|
1799
1757
|
"hasDynamicHelp": false,
|
|
1800
1758
|
"multiple": false,
|
|
1801
1759
|
"type": "option"
|
|
1802
1760
|
},
|
|
1803
|
-
"
|
|
1804
|
-
"
|
|
1805
|
-
"description": "If you don’t specify this flag, only changes in the stage’s branch are deployed.",
|
|
1806
|
-
"name": "deploy-all",
|
|
1807
|
-
"summary": "Deploy all metadata in the branch to the stage's org.",
|
|
1808
|
-
"allowNo": false,
|
|
1809
|
-
"type": "boolean"
|
|
1810
|
-
},
|
|
1811
|
-
"devops-center-project-name": {
|
|
1812
|
-
"char": "p",
|
|
1813
|
-
"name": "devops-center-project-name",
|
|
1761
|
+
"pipeline-id": {
|
|
1762
|
+
"name": "pipeline-id",
|
|
1814
1763
|
"required": true,
|
|
1815
|
-
"summary": "
|
|
1764
|
+
"summary": "ID of the pipeline that contains the stage.",
|
|
1816
1765
|
"hasDynamicHelp": false,
|
|
1817
1766
|
"multiple": false,
|
|
1818
1767
|
"type": "option"
|
|
1819
1768
|
},
|
|
1820
|
-
"
|
|
1821
|
-
"
|
|
1822
|
-
"name": "devops-center-username",
|
|
1769
|
+
"stage-id": {
|
|
1770
|
+
"name": "stage-id",
|
|
1823
1771
|
"required": true,
|
|
1824
|
-
"summary": "
|
|
1825
|
-
"hasDynamicHelp": true,
|
|
1826
|
-
"multiple": false,
|
|
1827
|
-
"type": "option"
|
|
1828
|
-
},
|
|
1829
|
-
"tests": {
|
|
1830
|
-
"char": "t",
|
|
1831
|
-
"description": "Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains spaces.",
|
|
1832
|
-
"name": "tests",
|
|
1833
|
-
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
1834
|
-
"hasDynamicHelp": false,
|
|
1835
|
-
"multiple": true,
|
|
1836
|
-
"type": "option"
|
|
1837
|
-
},
|
|
1838
|
-
"test-level": {
|
|
1839
|
-
"char": "l",
|
|
1840
|
-
"description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more information, see the section \"Running Tests in a Deployment\" in the \"Metadata API Developer Guide\". (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm)",
|
|
1841
|
-
"name": "test-level",
|
|
1842
|
-
"summary": "Deployment Apex testing level.",
|
|
1772
|
+
"summary": "ID of the stage to delete.",
|
|
1843
1773
|
"hasDynamicHelp": false,
|
|
1844
1774
|
"multiple": false,
|
|
1845
|
-
"options": [
|
|
1846
|
-
"NoTestRun",
|
|
1847
|
-
"RunSpecifiedTests",
|
|
1848
|
-
"RunLocalTests",
|
|
1849
|
-
"RunAllTestsInOrg"
|
|
1850
|
-
],
|
|
1851
|
-
"type": "option"
|
|
1852
|
-
},
|
|
1853
|
-
"async": {
|
|
1854
|
-
"description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"sf project deploy pipeline resume\". To check the status of the deployment, run \"sf project deploy pipeline report\".",
|
|
1855
|
-
"name": "async",
|
|
1856
|
-
"summary": "Run the command asynchronously.",
|
|
1857
|
-
"allowNo": false,
|
|
1858
|
-
"type": "boolean"
|
|
1859
|
-
},
|
|
1860
|
-
"wait": {
|
|
1861
|
-
"char": "w",
|
|
1862
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"sf project deploy pipeline report\".",
|
|
1863
|
-
"exclusive": [
|
|
1864
|
-
"async"
|
|
1865
|
-
],
|
|
1866
|
-
"name": "wait",
|
|
1867
|
-
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1868
|
-
"default": "33 minutes",
|
|
1869
|
-
"hasDynamicHelp": true,
|
|
1870
|
-
"helpValue": "<minutes>",
|
|
1871
|
-
"multiple": false,
|
|
1872
1775
|
"type": "option"
|
|
1873
|
-
},
|
|
1874
|
-
"verbose": {
|
|
1875
|
-
"name": "verbose",
|
|
1876
|
-
"summary": "Show verbose output of the command result.",
|
|
1877
|
-
"allowNo": false,
|
|
1878
|
-
"type": "boolean"
|
|
1879
|
-
},
|
|
1880
|
-
"concise": {
|
|
1881
|
-
"exclusive": [
|
|
1882
|
-
"verbose"
|
|
1883
|
-
],
|
|
1884
|
-
"name": "concise",
|
|
1885
|
-
"summary": "Show concise output of the command result.",
|
|
1886
|
-
"allowNo": false,
|
|
1887
|
-
"type": "boolean"
|
|
1888
1776
|
}
|
|
1889
1777
|
},
|
|
1890
1778
|
"hasDynamicHelp": true,
|
|
1891
1779
|
"hiddenAliases": [],
|
|
1892
|
-
"id": "
|
|
1780
|
+
"id": "devops:pipeline:stage:delete",
|
|
1893
1781
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
1894
1782
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
1895
1783
|
"pluginType": "core",
|
|
1896
|
-
"state": "beta",
|
|
1897
1784
|
"strict": true,
|
|
1898
|
-
"summary": "
|
|
1785
|
+
"summary": "Delete a stage from a DevOps Center pipeline.",
|
|
1899
1786
|
"enableJsonFlag": true,
|
|
1900
1787
|
"isESM": true,
|
|
1901
1788
|
"relativePath": [
|
|
1902
1789
|
"lib",
|
|
1903
1790
|
"commands",
|
|
1904
|
-
"
|
|
1905
|
-
"deploy",
|
|
1791
|
+
"devops",
|
|
1906
1792
|
"pipeline",
|
|
1907
|
-
"
|
|
1793
|
+
"stage",
|
|
1794
|
+
"delete.js"
|
|
1908
1795
|
]
|
|
1909
1796
|
},
|
|
1910
|
-
"
|
|
1797
|
+
"devops:pipeline:stage:update": {
|
|
1911
1798
|
"aliases": [],
|
|
1912
1799
|
"args": {},
|
|
1913
|
-
"description": "
|
|
1800
|
+
"description": "Updates the name of a pipeline stage.",
|
|
1914
1801
|
"examples": [
|
|
1915
|
-
"
|
|
1916
|
-
"Perform a validate-only deployment of all changes from the main branch to the release environment:\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name main --devops-center-username MyReleaseOrg --deploy-all"
|
|
1802
|
+
"Rename a pipeline stage.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --stage-id 1QV000000000001 --name \"Integration\""
|
|
1917
1803
|
],
|
|
1918
1804
|
"flags": {
|
|
1919
1805
|
"json": {
|
|
@@ -1931,137 +1817,68 @@
|
|
|
1931
1817
|
"multiple": false,
|
|
1932
1818
|
"type": "option"
|
|
1933
1819
|
},
|
|
1934
|
-
"
|
|
1935
|
-
"char": "
|
|
1936
|
-
"name": "
|
|
1820
|
+
"target-org": {
|
|
1821
|
+
"char": "o",
|
|
1822
|
+
"name": "target-org",
|
|
1823
|
+
"noCacheDefault": true,
|
|
1937
1824
|
"required": true,
|
|
1938
|
-
"summary": "
|
|
1939
|
-
"hasDynamicHelp":
|
|
1825
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1826
|
+
"hasDynamicHelp": true,
|
|
1940
1827
|
"multiple": false,
|
|
1941
1828
|
"type": "option"
|
|
1942
1829
|
},
|
|
1943
|
-
"
|
|
1944
|
-
"
|
|
1945
|
-
"
|
|
1946
|
-
"name": "bundle-version-name",
|
|
1947
|
-
"summary": "Version name of the bundle.",
|
|
1830
|
+
"api-version": {
|
|
1831
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1832
|
+
"name": "api-version",
|
|
1948
1833
|
"hasDynamicHelp": false,
|
|
1949
1834
|
"multiple": false,
|
|
1950
1835
|
"type": "option"
|
|
1951
1836
|
},
|
|
1952
|
-
"
|
|
1953
|
-
"char": "
|
|
1954
|
-
"
|
|
1955
|
-
"name": "deploy-all",
|
|
1956
|
-
"summary": "Deploy all metadata in the branch to the stage's org.",
|
|
1957
|
-
"allowNo": false,
|
|
1958
|
-
"type": "boolean"
|
|
1959
|
-
},
|
|
1960
|
-
"devops-center-project-name": {
|
|
1961
|
-
"char": "p",
|
|
1962
|
-
"name": "devops-center-project-name",
|
|
1837
|
+
"stage-id": {
|
|
1838
|
+
"char": "s",
|
|
1839
|
+
"name": "stage-id",
|
|
1963
1840
|
"required": true,
|
|
1964
|
-
"summary": "
|
|
1841
|
+
"summary": "ID of the pipeline stage to update.",
|
|
1965
1842
|
"hasDynamicHelp": false,
|
|
1966
1843
|
"multiple": false,
|
|
1967
1844
|
"type": "option"
|
|
1968
1845
|
},
|
|
1969
|
-
"
|
|
1970
|
-
"char": "
|
|
1971
|
-
"name": "
|
|
1846
|
+
"name": {
|
|
1847
|
+
"char": "n",
|
|
1848
|
+
"name": "name",
|
|
1972
1849
|
"required": true,
|
|
1973
|
-
"summary": "
|
|
1974
|
-
"hasDynamicHelp": true,
|
|
1975
|
-
"multiple": false,
|
|
1976
|
-
"type": "option"
|
|
1977
|
-
},
|
|
1978
|
-
"tests": {
|
|
1979
|
-
"char": "t",
|
|
1980
|
-
"description": "Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains spaces.",
|
|
1981
|
-
"name": "tests",
|
|
1982
|
-
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
1983
|
-
"hasDynamicHelp": false,
|
|
1984
|
-
"multiple": true,
|
|
1985
|
-
"type": "option"
|
|
1986
|
-
},
|
|
1987
|
-
"test-level": {
|
|
1988
|
-
"char": "l",
|
|
1989
|
-
"description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more information, see the section \"Running Tests in a Deployment\" in the \"Metadata API Developer Guide\". (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm)",
|
|
1990
|
-
"name": "test-level",
|
|
1991
|
-
"summary": "Deployment Apex testing level.",
|
|
1850
|
+
"summary": "New name for the pipeline stage.",
|
|
1992
1851
|
"hasDynamicHelp": false,
|
|
1993
1852
|
"multiple": false,
|
|
1994
|
-
"options": [
|
|
1995
|
-
"NoTestRun",
|
|
1996
|
-
"RunSpecifiedTests",
|
|
1997
|
-
"RunLocalTests",
|
|
1998
|
-
"RunAllTestsInOrg"
|
|
1999
|
-
],
|
|
2000
|
-
"type": "option"
|
|
2001
|
-
},
|
|
2002
|
-
"async": {
|
|
2003
|
-
"description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"sf project deploy pipeline resume\". To check the status of the deployment, run \"sf project deploy pipeline report\".",
|
|
2004
|
-
"name": "async",
|
|
2005
|
-
"summary": "Run the command asynchronously.",
|
|
2006
|
-
"allowNo": false,
|
|
2007
|
-
"type": "boolean"
|
|
2008
|
-
},
|
|
2009
|
-
"wait": {
|
|
2010
|
-
"char": "w",
|
|
2011
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"sf project deploy pipeline report\".",
|
|
2012
|
-
"exclusive": [
|
|
2013
|
-
"async"
|
|
2014
|
-
],
|
|
2015
|
-
"name": "wait",
|
|
2016
|
-
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
2017
|
-
"default": "33 minutes",
|
|
2018
|
-
"hasDynamicHelp": true,
|
|
2019
|
-
"helpValue": "<minutes>",
|
|
2020
|
-
"multiple": false,
|
|
2021
1853
|
"type": "option"
|
|
2022
|
-
},
|
|
2023
|
-
"verbose": {
|
|
2024
|
-
"name": "verbose",
|
|
2025
|
-
"summary": "Show verbose output of the command result.",
|
|
2026
|
-
"allowNo": false,
|
|
2027
|
-
"type": "boolean"
|
|
2028
|
-
},
|
|
2029
|
-
"concise": {
|
|
2030
|
-
"exclusive": [
|
|
2031
|
-
"verbose"
|
|
2032
|
-
],
|
|
2033
|
-
"name": "concise",
|
|
2034
|
-
"summary": "Show concise output of the command result.",
|
|
2035
|
-
"allowNo": false,
|
|
2036
|
-
"type": "boolean"
|
|
2037
1854
|
}
|
|
2038
1855
|
},
|
|
2039
1856
|
"hasDynamicHelp": true,
|
|
2040
1857
|
"hiddenAliases": [],
|
|
2041
|
-
"id": "
|
|
1858
|
+
"id": "devops:pipeline:stage:update",
|
|
2042
1859
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2043
1860
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
2044
1861
|
"pluginType": "core",
|
|
2045
|
-
"state": "beta",
|
|
2046
1862
|
"strict": true,
|
|
2047
|
-
"summary": "
|
|
1863
|
+
"summary": "Update a DevOps Center pipeline stage.",
|
|
2048
1864
|
"enableJsonFlag": true,
|
|
2049
1865
|
"isESM": true,
|
|
2050
1866
|
"relativePath": [
|
|
2051
1867
|
"lib",
|
|
2052
1868
|
"commands",
|
|
2053
|
-
"
|
|
2054
|
-
"deploy",
|
|
1869
|
+
"devops",
|
|
2055
1870
|
"pipeline",
|
|
2056
|
-
"
|
|
1871
|
+
"stage",
|
|
1872
|
+
"update.js"
|
|
2057
1873
|
]
|
|
2058
1874
|
},
|
|
2059
|
-
"devops:
|
|
1875
|
+
"devops:stage:branch:add": {
|
|
2060
1876
|
"aliases": [],
|
|
2061
1877
|
"args": {},
|
|
2062
|
-
"description": "
|
|
1878
|
+
"description": "By default, the branch must exist in the repository. Use --create-vcs-branch to create a branch if it doesn't exist.\nEach pipeline stage supports only one branch. If the stage already has a branch, the command blocks so the existing branch isn't orphaned; pass --force to replace it.",
|
|
2063
1879
|
"examples": [
|
|
2064
|
-
"
|
|
1880
|
+
"Add an existing branch to a stage:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0Xo000000000001 --stage-id 0Xp000000000001 --branch-name main",
|
|
1881
|
+
"Create and add a branch to a pipeline stage:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0Xo000000000001 --stage-id 0Xp000000000002 --branch-name integration --create-vcs-branch"
|
|
2065
1882
|
],
|
|
2066
1883
|
"flags": {
|
|
2067
1884
|
"json": {
|
|
@@ -2099,45 +1916,66 @@
|
|
|
2099
1916
|
"pipeline-id": {
|
|
2100
1917
|
"name": "pipeline-id",
|
|
2101
1918
|
"required": true,
|
|
2102
|
-
"summary": "ID of the pipeline.",
|
|
1919
|
+
"summary": "ID of the pipeline that contains the stage.",
|
|
2103
1920
|
"hasDynamicHelp": false,
|
|
2104
1921
|
"multiple": false,
|
|
2105
1922
|
"type": "option"
|
|
2106
1923
|
},
|
|
2107
|
-
"
|
|
2108
|
-
"name": "
|
|
1924
|
+
"stage-id": {
|
|
1925
|
+
"name": "stage-id",
|
|
2109
1926
|
"required": true,
|
|
2110
|
-
"summary": "ID of the
|
|
1927
|
+
"summary": "ID of the pipeline stage to associate the branch with.",
|
|
1928
|
+
"hasDynamicHelp": false,
|
|
1929
|
+
"multiple": false,
|
|
1930
|
+
"type": "option"
|
|
1931
|
+
},
|
|
1932
|
+
"branch-name": {
|
|
1933
|
+
"char": "b",
|
|
1934
|
+
"name": "branch-name",
|
|
1935
|
+
"required": true,
|
|
1936
|
+
"summary": "Name of the repository branch to assign to the stage.",
|
|
2111
1937
|
"hasDynamicHelp": false,
|
|
2112
1938
|
"multiple": false,
|
|
2113
1939
|
"type": "option"
|
|
1940
|
+
},
|
|
1941
|
+
"create-vcs-branch": {
|
|
1942
|
+
"name": "create-vcs-branch",
|
|
1943
|
+
"summary": "Create the branch in the remote repository if it doesn't already exist.",
|
|
1944
|
+
"allowNo": false,
|
|
1945
|
+
"type": "boolean"
|
|
1946
|
+
},
|
|
1947
|
+
"force": {
|
|
1948
|
+
"name": "force",
|
|
1949
|
+
"summary": "Replace the stage's existing branch. By default, the command blocks if the stage already has a branch to avoid orphaning it. With this flag, the new branch is associated and the previous branch record is removed if no other stage references it.",
|
|
1950
|
+
"allowNo": false,
|
|
1951
|
+
"type": "boolean"
|
|
2114
1952
|
}
|
|
2115
1953
|
},
|
|
2116
1954
|
"hasDynamicHelp": true,
|
|
2117
1955
|
"hiddenAliases": [],
|
|
2118
|
-
"id": "devops:
|
|
1956
|
+
"id": "devops:stage:branch:add",
|
|
2119
1957
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2120
1958
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
2121
1959
|
"pluginType": "core",
|
|
2122
1960
|
"strict": true,
|
|
2123
|
-
"summary": "
|
|
1961
|
+
"summary": "Add a source code repository branch to a pipeline stage.",
|
|
2124
1962
|
"enableJsonFlag": true,
|
|
2125
1963
|
"isESM": true,
|
|
2126
1964
|
"relativePath": [
|
|
2127
1965
|
"lib",
|
|
2128
1966
|
"commands",
|
|
2129
1967
|
"devops",
|
|
2130
|
-
"
|
|
2131
|
-
"
|
|
1968
|
+
"stage",
|
|
1969
|
+
"branch",
|
|
2132
1970
|
"add.js"
|
|
2133
1971
|
]
|
|
2134
1972
|
},
|
|
2135
|
-
"devops:
|
|
1973
|
+
"devops:stage:branch:delete": {
|
|
2136
1974
|
"aliases": [],
|
|
2137
1975
|
"args": {},
|
|
2138
|
-
"description": "
|
|
1976
|
+
"description": "Removes the branch linked to the specified pipeline stage. Because branches are configured from right to left (a stage can have a branch only after the stage to its right does), removing a branch also removes the branches from all upstream stages (to the left) in the pipeline, keeping it in a valid state. The branch records in the repository are not deleted; only their association with the stages is removed. The stage must belong to an inactive pipeline.",
|
|
2139
1977
|
"examples": [
|
|
2140
|
-
"
|
|
1978
|
+
"Delete the branch associated with a pipeline stage:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0Xo000000000001 --stage-id 0Xp000000000001"
|
|
2141
1979
|
],
|
|
2142
1980
|
"flags": {
|
|
2143
1981
|
"json": {
|
|
@@ -2175,15 +2013,15 @@
|
|
|
2175
2013
|
"pipeline-id": {
|
|
2176
2014
|
"name": "pipeline-id",
|
|
2177
2015
|
"required": true,
|
|
2178
|
-
"summary": "ID of the pipeline.",
|
|
2016
|
+
"summary": "ID of the pipeline that contains the stage. Used to verify the pipeline is inactive before deleting.",
|
|
2179
2017
|
"hasDynamicHelp": false,
|
|
2180
2018
|
"multiple": false,
|
|
2181
2019
|
"type": "option"
|
|
2182
2020
|
},
|
|
2183
|
-
"
|
|
2184
|
-
"name": "
|
|
2021
|
+
"stage-id": {
|
|
2022
|
+
"name": "stage-id",
|
|
2185
2023
|
"required": true,
|
|
2186
|
-
"summary": "ID of the
|
|
2024
|
+
"summary": "ID of the pipeline stage whose branch you want to delete.",
|
|
2187
2025
|
"hasDynamicHelp": false,
|
|
2188
2026
|
"multiple": false,
|
|
2189
2027
|
"type": "option"
|
|
@@ -2191,30 +2029,29 @@
|
|
|
2191
2029
|
},
|
|
2192
2030
|
"hasDynamicHelp": true,
|
|
2193
2031
|
"hiddenAliases": [],
|
|
2194
|
-
"id": "devops:
|
|
2032
|
+
"id": "devops:stage:branch:delete",
|
|
2195
2033
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2196
2034
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
2197
2035
|
"pluginType": "core",
|
|
2198
2036
|
"strict": true,
|
|
2199
|
-
"summary": "
|
|
2037
|
+
"summary": "Delete the source code repository branch associated with a pipeline stage.",
|
|
2200
2038
|
"enableJsonFlag": true,
|
|
2201
2039
|
"isESM": true,
|
|
2202
2040
|
"relativePath": [
|
|
2203
2041
|
"lib",
|
|
2204
2042
|
"commands",
|
|
2205
2043
|
"devops",
|
|
2206
|
-
"
|
|
2207
|
-
"
|
|
2044
|
+
"stage",
|
|
2045
|
+
"branch",
|
|
2208
2046
|
"delete.js"
|
|
2209
2047
|
]
|
|
2210
2048
|
},
|
|
2211
|
-
"devops:
|
|
2049
|
+
"devops:stage:environment:add": {
|
|
2212
2050
|
"aliases": [],
|
|
2213
2051
|
"args": {},
|
|
2214
|
-
"description": "
|
|
2052
|
+
"description": "This command triggers an OAuth flow to authenticate the environment. A browser window opens automatically for you to log in.",
|
|
2215
2053
|
"examples": [
|
|
2216
|
-
"Add a
|
|
2217
|
-
"Add a QA stage before UAT in a specific pipeline.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --name \"QA\" --next-stage-id 0Xc000000000003"
|
|
2054
|
+
"Add a production environment to a stage using its ID:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --stage-id 0Xp000000000001 --environment-name Production_Org --org-type Production"
|
|
2218
2055
|
],
|
|
2219
2056
|
"flags": {
|
|
2220
2057
|
"json": {
|
|
@@ -2252,54 +2089,78 @@
|
|
|
2252
2089
|
"pipeline-id": {
|
|
2253
2090
|
"name": "pipeline-id",
|
|
2254
2091
|
"required": true,
|
|
2255
|
-
"summary": "ID of the pipeline
|
|
2092
|
+
"summary": "ID of the pipeline that contains the stage.",
|
|
2256
2093
|
"hasDynamicHelp": false,
|
|
2257
2094
|
"multiple": false,
|
|
2258
2095
|
"type": "option"
|
|
2259
2096
|
},
|
|
2260
|
-
"
|
|
2261
|
-
"
|
|
2262
|
-
"name": "name",
|
|
2097
|
+
"stage-id": {
|
|
2098
|
+
"name": "stage-id",
|
|
2263
2099
|
"required": true,
|
|
2264
|
-
"summary": "
|
|
2100
|
+
"summary": "ID of the pipeline stage.",
|
|
2265
2101
|
"hasDynamicHelp": false,
|
|
2266
2102
|
"multiple": false,
|
|
2267
2103
|
"type": "option"
|
|
2268
2104
|
},
|
|
2269
|
-
"
|
|
2270
|
-
"
|
|
2105
|
+
"environment-name": {
|
|
2106
|
+
"char": "e",
|
|
2107
|
+
"name": "environment-name",
|
|
2271
2108
|
"required": true,
|
|
2272
|
-
"summary": "
|
|
2109
|
+
"summary": "Name of the environment.",
|
|
2110
|
+
"hasDynamicHelp": false,
|
|
2111
|
+
"multiple": false,
|
|
2112
|
+
"type": "option"
|
|
2113
|
+
},
|
|
2114
|
+
"org-type": {
|
|
2115
|
+
"name": "org-type",
|
|
2116
|
+
"required": true,
|
|
2117
|
+
"summary": "Type of the Salesforce org. Valid values: Production, Sandbox.",
|
|
2273
2118
|
"hasDynamicHelp": false,
|
|
2274
2119
|
"multiple": false,
|
|
2120
|
+
"options": [
|
|
2121
|
+
"Production",
|
|
2122
|
+
"Sandbox"
|
|
2123
|
+
],
|
|
2275
2124
|
"type": "option"
|
|
2125
|
+
},
|
|
2126
|
+
"no-browser": {
|
|
2127
|
+
"name": "no-browser",
|
|
2128
|
+
"summary": "Don't auto-open the browser for OAuth authentication. The redirect URL is printed for manual use.",
|
|
2129
|
+
"allowNo": false,
|
|
2130
|
+
"type": "boolean"
|
|
2131
|
+
},
|
|
2132
|
+
"force": {
|
|
2133
|
+
"name": "force",
|
|
2134
|
+
"summary": "Replace the stage's existing environment. By default, the command blocks if the stage already has an environment to avoid orphaning it. With this flag, the new environment is added first and the previous one is removed only after the new environment is associated successfully.",
|
|
2135
|
+
"allowNo": false,
|
|
2136
|
+
"type": "boolean"
|
|
2276
2137
|
}
|
|
2277
2138
|
},
|
|
2278
2139
|
"hasDynamicHelp": true,
|
|
2279
2140
|
"hiddenAliases": [],
|
|
2280
|
-
"id": "devops:
|
|
2141
|
+
"id": "devops:stage:environment:add",
|
|
2281
2142
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2282
2143
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
2283
2144
|
"pluginType": "core",
|
|
2284
2145
|
"strict": true,
|
|
2285
|
-
"summary": "Add a
|
|
2146
|
+
"summary": "Add a Salesforce environment to a pipeline stage.",
|
|
2286
2147
|
"enableJsonFlag": true,
|
|
2287
2148
|
"isESM": true,
|
|
2288
2149
|
"relativePath": [
|
|
2289
2150
|
"lib",
|
|
2290
2151
|
"commands",
|
|
2291
2152
|
"devops",
|
|
2292
|
-
"pipeline",
|
|
2293
2153
|
"stage",
|
|
2154
|
+
"environment",
|
|
2294
2155
|
"add.js"
|
|
2295
2156
|
]
|
|
2296
2157
|
},
|
|
2297
|
-
"devops:
|
|
2158
|
+
"devops:stage:environment:delete": {
|
|
2298
2159
|
"aliases": [],
|
|
2299
2160
|
"args": {},
|
|
2300
|
-
"description": "
|
|
2161
|
+
"description": "Removes the specified environment from the pipeline stage. The environment must belong to an inactive pipeline.",
|
|
2301
2162
|
"examples": [
|
|
2302
|
-
"Delete
|
|
2163
|
+
"Delete an environment:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --environment-id 0Xe000000000001"
|
|
2303
2164
|
],
|
|
2304
2165
|
"flags": {
|
|
2305
2166
|
"json": {
|
|
@@ -2337,15 +2198,16 @@
|
|
|
2337
2198
|
"pipeline-id": {
|
|
2338
2199
|
"name": "pipeline-id",
|
|
2339
2200
|
"required": true,
|
|
2340
|
-
"summary": "ID of the pipeline
|
|
2201
|
+
"summary": "ID of the pipeline. Used to verify the pipeline is inactive before deleting.",
|
|
2341
2202
|
"hasDynamicHelp": false,
|
|
2342
2203
|
"multiple": false,
|
|
2343
2204
|
"type": "option"
|
|
2344
2205
|
},
|
|
2345
|
-
"
|
|
2346
|
-
"
|
|
2206
|
+
"environment-id": {
|
|
2207
|
+
"char": "e",
|
|
2208
|
+
"name": "environment-id",
|
|
2347
2209
|
"required": true,
|
|
2348
|
-
"summary": "ID of the
|
|
2210
|
+
"summary": "ID of the environment to delete.",
|
|
2349
2211
|
"hasDynamicHelp": false,
|
|
2350
2212
|
"multiple": false,
|
|
2351
2213
|
"type": "option"
|
|
@@ -2353,29 +2215,30 @@
|
|
|
2353
2215
|
},
|
|
2354
2216
|
"hasDynamicHelp": true,
|
|
2355
2217
|
"hiddenAliases": [],
|
|
2356
|
-
"id": "devops:
|
|
2218
|
+
"id": "devops:stage:environment:delete",
|
|
2357
2219
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2358
2220
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
2359
2221
|
"pluginType": "core",
|
|
2360
2222
|
"strict": true,
|
|
2361
|
-
"summary": "Delete
|
|
2223
|
+
"summary": "Delete an environment from a DevOps Center pipeline stage.",
|
|
2362
2224
|
"enableJsonFlag": true,
|
|
2363
2225
|
"isESM": true,
|
|
2364
2226
|
"relativePath": [
|
|
2365
2227
|
"lib",
|
|
2366
2228
|
"commands",
|
|
2367
2229
|
"devops",
|
|
2368
|
-
"pipeline",
|
|
2369
2230
|
"stage",
|
|
2231
|
+
"environment",
|
|
2370
2232
|
"delete.js"
|
|
2371
2233
|
]
|
|
2372
2234
|
},
|
|
2373
|
-
"
|
|
2235
|
+
"project:deploy:pipeline:quick": {
|
|
2374
2236
|
"aliases": [],
|
|
2375
2237
|
"args": {},
|
|
2376
|
-
"description": "
|
|
2238
|
+
"description": "The first time you run any \"project deploy pipeline\" command, be sure to authorize the org in which DevOps Center is installed. The easiest way to authorize an org is with the \"org login web\" command.\n\nBefore you run this command, create a validated deployment with the \"project deploy pipeline validate\" command, which returns a job ID. Validated deployments haven't been deployed to the org yet; you deploy them with this command. Either pass the job ID to this command or use the --use-most-recent flag to use the job ID of the most recently validated deployment. For the quick deploy to succeed, the associated validated deployment must also have succeeded.\n\nExecuting this quick deploy command takes less time than a standard deploy because it skips running Apex tests. These tests were previously run as part of the validation. Validating first and then running a quick deploy is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.\n\nThis command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org. This command doesn’t attempt to merge your source with the versions in your org.",
|
|
2377
2239
|
"examples": [
|
|
2378
|
-
"
|
|
2240
|
+
"Run a quick deploy using your default Devops Center org and a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
2241
|
+
"Asynchronously run a quick deploy of the most recently validated deployment using an org with alias \"my-prod-org\":\n<%= config.bin %> <%= command.id %> --async --use-most-recent --devops-center-username my-prod-org"
|
|
2379
2242
|
],
|
|
2380
2243
|
"flags": {
|
|
2381
2244
|
"json": {
|
|
@@ -2393,68 +2256,96 @@
|
|
|
2393
2256
|
"multiple": false,
|
|
2394
2257
|
"type": "option"
|
|
2395
2258
|
},
|
|
2396
|
-
"
|
|
2397
|
-
"
|
|
2398
|
-
"name": "
|
|
2399
|
-
"
|
|
2400
|
-
"
|
|
2401
|
-
"
|
|
2402
|
-
"hasDynamicHelp": true,
|
|
2403
|
-
"multiple": false,
|
|
2404
|
-
"type": "option"
|
|
2259
|
+
"async": {
|
|
2260
|
+
"description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"sf project deploy pipeline resume\". To check the status of the deployment, run \"sf project deploy pipeline report\".",
|
|
2261
|
+
"name": "async",
|
|
2262
|
+
"summary": "Run the command asynchronously.",
|
|
2263
|
+
"allowNo": false,
|
|
2264
|
+
"type": "boolean"
|
|
2405
2265
|
},
|
|
2406
|
-
"
|
|
2407
|
-
"
|
|
2408
|
-
|
|
2409
|
-
|
|
2266
|
+
"concise": {
|
|
2267
|
+
"exclusive": [
|
|
2268
|
+
"verbose"
|
|
2269
|
+
],
|
|
2270
|
+
"name": "concise",
|
|
2271
|
+
"summary": "Show concise output of the command result.",
|
|
2272
|
+
"allowNo": false,
|
|
2273
|
+
"type": "boolean"
|
|
2274
|
+
},
|
|
2275
|
+
"verbose": {
|
|
2276
|
+
"name": "verbose",
|
|
2277
|
+
"summary": "Show verbose output of the command result.",
|
|
2278
|
+
"allowNo": false,
|
|
2279
|
+
"type": "boolean"
|
|
2280
|
+
},
|
|
2281
|
+
"wait": {
|
|
2282
|
+
"char": "w",
|
|
2283
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"sf project deploy pipeline report\".",
|
|
2284
|
+
"exclusive": [
|
|
2285
|
+
"async"
|
|
2286
|
+
],
|
|
2287
|
+
"name": "wait",
|
|
2288
|
+
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
2289
|
+
"default": "33 minutes",
|
|
2290
|
+
"hasDynamicHelp": true,
|
|
2291
|
+
"helpValue": "<minutes>",
|
|
2410
2292
|
"multiple": false,
|
|
2411
2293
|
"type": "option"
|
|
2412
2294
|
},
|
|
2413
|
-
"
|
|
2414
|
-
"char": "
|
|
2415
|
-
"name": "
|
|
2295
|
+
"devops-center-username": {
|
|
2296
|
+
"char": "c",
|
|
2297
|
+
"name": "devops-center-username",
|
|
2416
2298
|
"required": true,
|
|
2417
|
-
"summary": "
|
|
2418
|
-
"hasDynamicHelp":
|
|
2299
|
+
"summary": "Username or alias of the DevOps Center org.",
|
|
2300
|
+
"hasDynamicHelp": true,
|
|
2419
2301
|
"multiple": false,
|
|
2420
2302
|
"type": "option"
|
|
2421
2303
|
},
|
|
2422
|
-
"
|
|
2423
|
-
"char": "
|
|
2424
|
-
"
|
|
2425
|
-
"
|
|
2426
|
-
"summary": "
|
|
2304
|
+
"job-id": {
|
|
2305
|
+
"char": "i",
|
|
2306
|
+
"description": "The job ID is valid for 10 days from when you started the validation.",
|
|
2307
|
+
"name": "job-id",
|
|
2308
|
+
"summary": "Job ID of the validated deployment to quick deploy.",
|
|
2427
2309
|
"hasDynamicHelp": false,
|
|
2428
2310
|
"multiple": false,
|
|
2429
2311
|
"type": "option"
|
|
2312
|
+
},
|
|
2313
|
+
"use-most-recent": {
|
|
2314
|
+
"char": "r",
|
|
2315
|
+
"description": "For performance reasons, this flag uses only job IDs that were validated in the past 3 days or less. If your most recent deployment validation was more than 3 days ago, this flag won't find the job ID.",
|
|
2316
|
+
"name": "use-most-recent",
|
|
2317
|
+
"summary": "Use the job ID of the most recently validated deployment.",
|
|
2318
|
+
"allowNo": false,
|
|
2319
|
+
"type": "boolean"
|
|
2430
2320
|
}
|
|
2431
2321
|
},
|
|
2432
2322
|
"hasDynamicHelp": true,
|
|
2433
2323
|
"hiddenAliases": [],
|
|
2434
|
-
"id": "
|
|
2324
|
+
"id": "project:deploy:pipeline:quick",
|
|
2435
2325
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2436
2326
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
2437
2327
|
"pluginType": "core",
|
|
2328
|
+
"state": "beta",
|
|
2438
2329
|
"strict": true,
|
|
2439
|
-
"summary": "
|
|
2330
|
+
"summary": "Quickly deploy a validated deployment to an org.",
|
|
2440
2331
|
"enableJsonFlag": true,
|
|
2441
2332
|
"isESM": true,
|
|
2442
2333
|
"relativePath": [
|
|
2443
2334
|
"lib",
|
|
2444
2335
|
"commands",
|
|
2445
|
-
"
|
|
2336
|
+
"project",
|
|
2337
|
+
"deploy",
|
|
2446
2338
|
"pipeline",
|
|
2447
|
-
"
|
|
2448
|
-
"update.js"
|
|
2339
|
+
"quick.js"
|
|
2449
2340
|
]
|
|
2450
2341
|
},
|
|
2451
|
-
"
|
|
2342
|
+
"project:deploy:pipeline:report": {
|
|
2452
2343
|
"aliases": [],
|
|
2453
2344
|
"args": {},
|
|
2454
|
-
"description": "
|
|
2345
|
+
"description": "The first time you run any \"project deploy pipeline\" command, be sure to authorize the org in which DevOps Center is installed. The easiest way to authorize an org is with the \"org login web\" command.\n\nRun this command by either indicating a job ID or specifying the —use-most-recent flag to use the job ID of the most recent deploy operation.",
|
|
2455
2346
|
"examples": [
|
|
2456
|
-
"
|
|
2457
|
-
"
|
|
2347
|
+
"Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --devops-center-username MyStagingSandbox --job-id 0Af0x000017yLUFCA2",
|
|
2348
|
+
"Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --devops-center-username MyStagingSandbox --use-most-recent"
|
|
2458
2349
|
],
|
|
2459
2350
|
"flags": {
|
|
2460
2351
|
"json": {
|
|
@@ -2472,86 +2363,60 @@
|
|
|
2472
2363
|
"multiple": false,
|
|
2473
2364
|
"type": "option"
|
|
2474
2365
|
},
|
|
2475
|
-
"
|
|
2476
|
-
"char": "
|
|
2477
|
-
"name": "
|
|
2478
|
-
"noCacheDefault": true,
|
|
2366
|
+
"devops-center-username": {
|
|
2367
|
+
"char": "c",
|
|
2368
|
+
"name": "devops-center-username",
|
|
2479
2369
|
"required": true,
|
|
2480
|
-
"summary": "Username or alias of the
|
|
2370
|
+
"summary": "Username or alias of the DevOps Center org.",
|
|
2481
2371
|
"hasDynamicHelp": true,
|
|
2482
2372
|
"multiple": false,
|
|
2483
2373
|
"type": "option"
|
|
2484
2374
|
},
|
|
2485
|
-
"
|
|
2486
|
-
"
|
|
2487
|
-
"
|
|
2488
|
-
"
|
|
2489
|
-
"
|
|
2490
|
-
"type": "option"
|
|
2491
|
-
},
|
|
2492
|
-
"pipeline-id": {
|
|
2493
|
-
"name": "pipeline-id",
|
|
2494
|
-
"required": true,
|
|
2495
|
-
"summary": "ID of the pipeline that contains the stage.",
|
|
2496
|
-
"hasDynamicHelp": false,
|
|
2497
|
-
"multiple": false,
|
|
2498
|
-
"type": "option"
|
|
2499
|
-
},
|
|
2500
|
-
"stage-id": {
|
|
2501
|
-
"name": "stage-id",
|
|
2502
|
-
"required": true,
|
|
2503
|
-
"summary": "ID of the pipeline stage to associate the branch with.",
|
|
2504
|
-
"hasDynamicHelp": false,
|
|
2505
|
-
"multiple": false,
|
|
2506
|
-
"type": "option"
|
|
2507
|
-
},
|
|
2508
|
-
"branch-name": {
|
|
2509
|
-
"char": "b",
|
|
2510
|
-
"name": "branch-name",
|
|
2511
|
-
"required": true,
|
|
2512
|
-
"summary": "Name of the repository branch to assign to the stage.",
|
|
2375
|
+
"job-id": {
|
|
2376
|
+
"char": "i",
|
|
2377
|
+
"description": "The job ID is valid for 10 days from when you started the deploy operation.",
|
|
2378
|
+
"name": "job-id",
|
|
2379
|
+
"summary": "Job ID of the pipeline deployment to check the status of.",
|
|
2513
2380
|
"hasDynamicHelp": false,
|
|
2514
2381
|
"multiple": false,
|
|
2515
2382
|
"type": "option"
|
|
2516
2383
|
},
|
|
2517
|
-
"
|
|
2518
|
-
"
|
|
2519
|
-
"
|
|
2520
|
-
"
|
|
2521
|
-
"
|
|
2522
|
-
},
|
|
2523
|
-
"force": {
|
|
2524
|
-
"name": "force",
|
|
2525
|
-
"summary": "Replace the stage's existing branch. By default, the command blocks if the stage already has a branch to avoid orphaning it. With this flag, the new branch is associated and the previous branch record is removed if no other stage references it.",
|
|
2384
|
+
"use-most-recent": {
|
|
2385
|
+
"char": "r",
|
|
2386
|
+
"description": "For performance reasons, this flag uses job IDs for deploy operations that started in the past 3 days or fewer. If your most recent operation was longer than 3 days ago, this flag won't find the job ID.",
|
|
2387
|
+
"name": "use-most-recent",
|
|
2388
|
+
"summary": "Use the job ID of the most recent deploy operation.",
|
|
2526
2389
|
"allowNo": false,
|
|
2527
2390
|
"type": "boolean"
|
|
2528
2391
|
}
|
|
2529
2392
|
},
|
|
2530
2393
|
"hasDynamicHelp": true,
|
|
2531
2394
|
"hiddenAliases": [],
|
|
2532
|
-
"id": "
|
|
2395
|
+
"id": "project:deploy:pipeline:report",
|
|
2533
2396
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2534
2397
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
2535
2398
|
"pluginType": "core",
|
|
2399
|
+
"state": "beta",
|
|
2536
2400
|
"strict": true,
|
|
2537
|
-
"summary": "
|
|
2401
|
+
"summary": "Check the status of a pipeline deploy operation.",
|
|
2538
2402
|
"enableJsonFlag": true,
|
|
2539
2403
|
"isESM": true,
|
|
2540
2404
|
"relativePath": [
|
|
2541
2405
|
"lib",
|
|
2542
2406
|
"commands",
|
|
2543
|
-
"
|
|
2544
|
-
"
|
|
2545
|
-
"
|
|
2546
|
-
"
|
|
2407
|
+
"project",
|
|
2408
|
+
"deploy",
|
|
2409
|
+
"pipeline",
|
|
2410
|
+
"report.js"
|
|
2547
2411
|
]
|
|
2548
2412
|
},
|
|
2549
|
-
"
|
|
2413
|
+
"project:deploy:pipeline:resume": {
|
|
2550
2414
|
"aliases": [],
|
|
2551
2415
|
"args": {},
|
|
2552
|
-
"description": "
|
|
2416
|
+
"description": "The first time you run any \"project deploy pipeline\" command, be sure to authorize the org in which DevOps Center is installed. The easiest way to authorize an org is with the \"org login web\" command. \n\nUse this command to resume watching a pipeline deploy operation if the original command times out or you specified the --async flag.\n\nRun this command by either indicating a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.",
|
|
2553
2417
|
"examples": [
|
|
2554
|
-
"
|
|
2418
|
+
"Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
2419
|
+
"Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
2555
2420
|
],
|
|
2556
2421
|
"flags": {
|
|
2557
2422
|
"json": {
|
|
@@ -2569,65 +2434,89 @@
|
|
|
2569
2434
|
"multiple": false,
|
|
2570
2435
|
"type": "option"
|
|
2571
2436
|
},
|
|
2572
|
-
"
|
|
2573
|
-
"char": "
|
|
2574
|
-
"name": "
|
|
2575
|
-
"noCacheDefault": true,
|
|
2437
|
+
"devops-center-username": {
|
|
2438
|
+
"char": "c",
|
|
2439
|
+
"name": "devops-center-username",
|
|
2576
2440
|
"required": true,
|
|
2577
|
-
"summary": "Username or alias of the
|
|
2441
|
+
"summary": "Username or alias of the DevOps Center org.",
|
|
2578
2442
|
"hasDynamicHelp": true,
|
|
2579
2443
|
"multiple": false,
|
|
2580
2444
|
"type": "option"
|
|
2581
2445
|
},
|
|
2582
|
-
"
|
|
2583
|
-
"
|
|
2584
|
-
"
|
|
2446
|
+
"job-id": {
|
|
2447
|
+
"char": "i",
|
|
2448
|
+
"description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- sf project deploy pipeline start\n- sf project deploy pipeline validate\n- sf project deploy pipeline quick\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
|
|
2449
|
+
"name": "job-id",
|
|
2450
|
+
"summary": "Job ID of the pipeline deploy operation you want to resume.",
|
|
2585
2451
|
"hasDynamicHelp": false,
|
|
2586
2452
|
"multiple": false,
|
|
2587
2453
|
"type": "option"
|
|
2588
2454
|
},
|
|
2589
|
-
"
|
|
2590
|
-
"
|
|
2591
|
-
"
|
|
2592
|
-
"
|
|
2593
|
-
"
|
|
2594
|
-
"
|
|
2595
|
-
"type": "
|
|
2455
|
+
"use-most-recent": {
|
|
2456
|
+
"char": "r",
|
|
2457
|
+
"description": "For performance reasons, this flag uses job IDs for operations that started in the past 3 days or fewer. If your most recent operation was longer than 3 days ago, this flag won't find a job ID.",
|
|
2458
|
+
"name": "use-most-recent",
|
|
2459
|
+
"summary": "Use the job ID of the most recent deploy operation.",
|
|
2460
|
+
"allowNo": false,
|
|
2461
|
+
"type": "boolean"
|
|
2596
2462
|
},
|
|
2597
|
-
"
|
|
2598
|
-
"
|
|
2599
|
-
|
|
2600
|
-
|
|
2601
|
-
"
|
|
2463
|
+
"concise": {
|
|
2464
|
+
"exclusive": [
|
|
2465
|
+
"verbose"
|
|
2466
|
+
],
|
|
2467
|
+
"name": "concise",
|
|
2468
|
+
"summary": "Show concise output of the command result.",
|
|
2469
|
+
"allowNo": false,
|
|
2470
|
+
"type": "boolean"
|
|
2471
|
+
},
|
|
2472
|
+
"verbose": {
|
|
2473
|
+
"name": "verbose",
|
|
2474
|
+
"summary": "Show verbose output of the command result.",
|
|
2475
|
+
"allowNo": false,
|
|
2476
|
+
"type": "boolean"
|
|
2477
|
+
},
|
|
2478
|
+
"wait": {
|
|
2479
|
+
"char": "w",
|
|
2480
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"sf project deploy pipeline report\".",
|
|
2481
|
+
"exclusive": [
|
|
2482
|
+
"async"
|
|
2483
|
+
],
|
|
2484
|
+
"name": "wait",
|
|
2485
|
+
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
2486
|
+
"default": "33 minutes",
|
|
2487
|
+
"hasDynamicHelp": true,
|
|
2488
|
+
"helpValue": "<minutes>",
|
|
2602
2489
|
"multiple": false,
|
|
2603
2490
|
"type": "option"
|
|
2604
2491
|
}
|
|
2605
2492
|
},
|
|
2606
2493
|
"hasDynamicHelp": true,
|
|
2607
2494
|
"hiddenAliases": [],
|
|
2608
|
-
"id": "
|
|
2495
|
+
"id": "project:deploy:pipeline:resume",
|
|
2609
2496
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2610
2497
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
2611
2498
|
"pluginType": "core",
|
|
2499
|
+
"state": "beta",
|
|
2612
2500
|
"strict": true,
|
|
2613
|
-
"summary": "
|
|
2501
|
+
"summary": "Resume watching a pipeline deploy operation.",
|
|
2614
2502
|
"enableJsonFlag": true,
|
|
2615
2503
|
"isESM": true,
|
|
2616
2504
|
"relativePath": [
|
|
2617
2505
|
"lib",
|
|
2618
2506
|
"commands",
|
|
2619
|
-
"
|
|
2620
|
-
"
|
|
2621
|
-
"
|
|
2622
|
-
"
|
|
2507
|
+
"project",
|
|
2508
|
+
"deploy",
|
|
2509
|
+
"pipeline",
|
|
2510
|
+
"resume.js"
|
|
2623
2511
|
]
|
|
2624
2512
|
},
|
|
2625
|
-
"
|
|
2513
|
+
"project:deploy:pipeline:start": {
|
|
2626
2514
|
"aliases": [],
|
|
2627
2515
|
"args": {},
|
|
2628
|
-
"description": "
|
|
2516
|
+
"description": "The first time you run any \"project deploy pipeline\" command, be sure to authorize the org in which DevOps Center is installed. The easiest way to authorize an org is with the \"org login web\" command.\n\nBefore you run this command, changes in the pipeline stage's branch must be merged in the source control repository.",
|
|
2629
2517
|
"examples": [
|
|
2630
|
-
"
|
|
2518
|
+
"Deploy changes in the Staging branch to the Staging environment (sandbox), if the previous stage is the bundling stage:\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name staging --devops-center-username MyStagingSandbox --bundle-version-name 1.0",
|
|
2519
|
+
"Deploy all changes in the main branch to the release environment:\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name main --devops-center-username MyReleaseOrg --deploy-all"
|
|
2631
2520
|
],
|
|
2632
2521
|
"flags": {
|
|
2633
2522
|
"json": {
|
|
@@ -2645,98 +2534,138 @@
|
|
|
2645
2534
|
"multiple": false,
|
|
2646
2535
|
"type": "option"
|
|
2647
2536
|
},
|
|
2648
|
-
"
|
|
2649
|
-
"char": "
|
|
2650
|
-
"name": "
|
|
2651
|
-
"noCacheDefault": true,
|
|
2537
|
+
"branch-name": {
|
|
2538
|
+
"char": "b",
|
|
2539
|
+
"name": "branch-name",
|
|
2652
2540
|
"required": true,
|
|
2653
|
-
"summary": "
|
|
2654
|
-
"hasDynamicHelp":
|
|
2541
|
+
"summary": "Name of the branch in the source control repository that corresponds to the pipeline stage that you want to deploy the changes to.",
|
|
2542
|
+
"hasDynamicHelp": false,
|
|
2655
2543
|
"multiple": false,
|
|
2656
2544
|
"type": "option"
|
|
2657
2545
|
},
|
|
2658
|
-
"
|
|
2659
|
-
"
|
|
2660
|
-
"
|
|
2546
|
+
"bundle-version-name": {
|
|
2547
|
+
"char": "v",
|
|
2548
|
+
"description": "You must indicate the bundle version if deploying to the environment that corresponds to the first stage after the bundling stage.",
|
|
2549
|
+
"name": "bundle-version-name",
|
|
2550
|
+
"summary": "Version name of the bundle.",
|
|
2661
2551
|
"hasDynamicHelp": false,
|
|
2662
2552
|
"multiple": false,
|
|
2663
2553
|
"type": "option"
|
|
2664
2554
|
},
|
|
2665
|
-
"
|
|
2666
|
-
"
|
|
2555
|
+
"deploy-all": {
|
|
2556
|
+
"char": "a",
|
|
2557
|
+
"description": "If you don’t specify this flag, only changes in the stage’s branch are deployed.",
|
|
2558
|
+
"name": "deploy-all",
|
|
2559
|
+
"summary": "Deploy all metadata in the branch to the stage's org.",
|
|
2560
|
+
"allowNo": false,
|
|
2561
|
+
"type": "boolean"
|
|
2562
|
+
},
|
|
2563
|
+
"devops-center-project-name": {
|
|
2564
|
+
"char": "p",
|
|
2565
|
+
"name": "devops-center-project-name",
|
|
2667
2566
|
"required": true,
|
|
2668
|
-
"summary": "
|
|
2567
|
+
"summary": "Name of the DevOps Center project.",
|
|
2669
2568
|
"hasDynamicHelp": false,
|
|
2670
2569
|
"multiple": false,
|
|
2671
2570
|
"type": "option"
|
|
2672
2571
|
},
|
|
2673
|
-
"
|
|
2674
|
-
"
|
|
2572
|
+
"devops-center-username": {
|
|
2573
|
+
"char": "c",
|
|
2574
|
+
"name": "devops-center-username",
|
|
2675
2575
|
"required": true,
|
|
2676
|
-
"summary": "
|
|
2677
|
-
"hasDynamicHelp":
|
|
2576
|
+
"summary": "Username or alias of the DevOps Center org.",
|
|
2577
|
+
"hasDynamicHelp": true,
|
|
2678
2578
|
"multiple": false,
|
|
2679
2579
|
"type": "option"
|
|
2680
2580
|
},
|
|
2681
|
-
"
|
|
2682
|
-
"char": "
|
|
2683
|
-
"
|
|
2684
|
-
"
|
|
2685
|
-
"summary": "
|
|
2581
|
+
"tests": {
|
|
2582
|
+
"char": "t",
|
|
2583
|
+
"description": "Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains spaces.",
|
|
2584
|
+
"name": "tests",
|
|
2585
|
+
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
2686
2586
|
"hasDynamicHelp": false,
|
|
2687
|
-
"multiple":
|
|
2587
|
+
"multiple": true,
|
|
2688
2588
|
"type": "option"
|
|
2689
2589
|
},
|
|
2690
|
-
"
|
|
2691
|
-
"
|
|
2692
|
-
"
|
|
2693
|
-
"
|
|
2590
|
+
"test-level": {
|
|
2591
|
+
"char": "l",
|
|
2592
|
+
"description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more information, see the section \"Running Tests in a Deployment\" in the \"Metadata API Developer Guide\". (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm)",
|
|
2593
|
+
"name": "test-level",
|
|
2594
|
+
"summary": "Deployment Apex testing level.",
|
|
2694
2595
|
"hasDynamicHelp": false,
|
|
2695
2596
|
"multiple": false,
|
|
2696
2597
|
"options": [
|
|
2697
|
-
"
|
|
2698
|
-
"
|
|
2598
|
+
"NoTestRun",
|
|
2599
|
+
"RunSpecifiedTests",
|
|
2600
|
+
"RunLocalTests",
|
|
2601
|
+
"RunAllTestsInOrg"
|
|
2699
2602
|
],
|
|
2700
2603
|
"type": "option"
|
|
2701
2604
|
},
|
|
2702
|
-
"
|
|
2703
|
-
"
|
|
2704
|
-
"
|
|
2605
|
+
"async": {
|
|
2606
|
+
"description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"sf project deploy pipeline resume\". To check the status of the deployment, run \"sf project deploy pipeline report\".",
|
|
2607
|
+
"name": "async",
|
|
2608
|
+
"summary": "Run the command asynchronously.",
|
|
2705
2609
|
"allowNo": false,
|
|
2706
2610
|
"type": "boolean"
|
|
2707
2611
|
},
|
|
2708
|
-
"
|
|
2709
|
-
"
|
|
2710
|
-
"
|
|
2612
|
+
"wait": {
|
|
2613
|
+
"char": "w",
|
|
2614
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"sf project deploy pipeline report\".",
|
|
2615
|
+
"exclusive": [
|
|
2616
|
+
"async"
|
|
2617
|
+
],
|
|
2618
|
+
"name": "wait",
|
|
2619
|
+
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
2620
|
+
"default": "33 minutes",
|
|
2621
|
+
"hasDynamicHelp": true,
|
|
2622
|
+
"helpValue": "<minutes>",
|
|
2623
|
+
"multiple": false,
|
|
2624
|
+
"type": "option"
|
|
2625
|
+
},
|
|
2626
|
+
"verbose": {
|
|
2627
|
+
"name": "verbose",
|
|
2628
|
+
"summary": "Show verbose output of the command result.",
|
|
2629
|
+
"allowNo": false,
|
|
2630
|
+
"type": "boolean"
|
|
2631
|
+
},
|
|
2632
|
+
"concise": {
|
|
2633
|
+
"exclusive": [
|
|
2634
|
+
"verbose"
|
|
2635
|
+
],
|
|
2636
|
+
"name": "concise",
|
|
2637
|
+
"summary": "Show concise output of the command result.",
|
|
2711
2638
|
"allowNo": false,
|
|
2712
2639
|
"type": "boolean"
|
|
2713
2640
|
}
|
|
2714
2641
|
},
|
|
2715
2642
|
"hasDynamicHelp": true,
|
|
2716
2643
|
"hiddenAliases": [],
|
|
2717
|
-
"id": "
|
|
2644
|
+
"id": "project:deploy:pipeline:start",
|
|
2718
2645
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2719
2646
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
2720
2647
|
"pluginType": "core",
|
|
2648
|
+
"state": "beta",
|
|
2721
2649
|
"strict": true,
|
|
2722
|
-
"summary": "
|
|
2650
|
+
"summary": "Deploy changes from a branch to the pipeline stage’s org.",
|
|
2723
2651
|
"enableJsonFlag": true,
|
|
2724
2652
|
"isESM": true,
|
|
2725
2653
|
"relativePath": [
|
|
2726
2654
|
"lib",
|
|
2727
2655
|
"commands",
|
|
2728
|
-
"
|
|
2729
|
-
"
|
|
2730
|
-
"
|
|
2731
|
-
"
|
|
2656
|
+
"project",
|
|
2657
|
+
"deploy",
|
|
2658
|
+
"pipeline",
|
|
2659
|
+
"start.js"
|
|
2732
2660
|
]
|
|
2733
2661
|
},
|
|
2734
|
-
"
|
|
2662
|
+
"project:deploy:pipeline:validate": {
|
|
2735
2663
|
"aliases": [],
|
|
2736
2664
|
"args": {},
|
|
2737
|
-
"description": "
|
|
2665
|
+
"description": "The first time you run any \"project deploy pipeline\" command, be sure to authorize the org in which DevOps Center is installed. The easiest way to authorize an org is with the \"org login web\" command.\n\nA validation runs Apex tests to verify whether a deployment will succeed without actually deploying the metadata to your environment, so you can then quickly deploy the changes later without re-running the tests.",
|
|
2738
2666
|
"examples": [
|
|
2739
|
-
"
|
|
2667
|
+
"Perform a validate-only deployment from the Staging branch to the Staging environment (sandbox):\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name staging --devops-center-username MyStagingSandbox",
|
|
2668
|
+
"Perform a validate-only deployment of all changes from the main branch to the release environment:\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name main --devops-center-username MyReleaseOrg --deploy-all"
|
|
2740
2669
|
],
|
|
2741
2670
|
"flags": {
|
|
2742
2671
|
"json": {
|
|
@@ -2754,60 +2683,131 @@
|
|
|
2754
2683
|
"multiple": false,
|
|
2755
2684
|
"type": "option"
|
|
2756
2685
|
},
|
|
2757
|
-
"
|
|
2758
|
-
"char": "
|
|
2759
|
-
"name": "
|
|
2760
|
-
"noCacheDefault": true,
|
|
2686
|
+
"branch-name": {
|
|
2687
|
+
"char": "b",
|
|
2688
|
+
"name": "branch-name",
|
|
2761
2689
|
"required": true,
|
|
2762
|
-
"summary": "
|
|
2763
|
-
"hasDynamicHelp":
|
|
2690
|
+
"summary": "Name of the branch in the source control repository that corresponds to the pipeline stage that you want to deploy the changes to.",
|
|
2691
|
+
"hasDynamicHelp": false,
|
|
2764
2692
|
"multiple": false,
|
|
2765
2693
|
"type": "option"
|
|
2766
2694
|
},
|
|
2767
|
-
"
|
|
2768
|
-
"
|
|
2769
|
-
"
|
|
2695
|
+
"bundle-version-name": {
|
|
2696
|
+
"char": "v",
|
|
2697
|
+
"description": "You must indicate the bundle version if deploying to the environment that corresponds to the first stage after the bundling stage.",
|
|
2698
|
+
"name": "bundle-version-name",
|
|
2699
|
+
"summary": "Version name of the bundle.",
|
|
2770
2700
|
"hasDynamicHelp": false,
|
|
2771
2701
|
"multiple": false,
|
|
2772
2702
|
"type": "option"
|
|
2773
2703
|
},
|
|
2774
|
-
"
|
|
2775
|
-
"
|
|
2704
|
+
"deploy-all": {
|
|
2705
|
+
"char": "a",
|
|
2706
|
+
"description": "If you don’t specify this flag, only changes in the stage’s branch are deployed.",
|
|
2707
|
+
"name": "deploy-all",
|
|
2708
|
+
"summary": "Deploy all metadata in the branch to the stage's org.",
|
|
2709
|
+
"allowNo": false,
|
|
2710
|
+
"type": "boolean"
|
|
2711
|
+
},
|
|
2712
|
+
"devops-center-project-name": {
|
|
2713
|
+
"char": "p",
|
|
2714
|
+
"name": "devops-center-project-name",
|
|
2776
2715
|
"required": true,
|
|
2777
|
-
"summary": "
|
|
2716
|
+
"summary": "Name of the DevOps Center project.",
|
|
2778
2717
|
"hasDynamicHelp": false,
|
|
2779
2718
|
"multiple": false,
|
|
2780
2719
|
"type": "option"
|
|
2781
2720
|
},
|
|
2782
|
-
"
|
|
2783
|
-
"char": "
|
|
2784
|
-
"name": "
|
|
2721
|
+
"devops-center-username": {
|
|
2722
|
+
"char": "c",
|
|
2723
|
+
"name": "devops-center-username",
|
|
2785
2724
|
"required": true,
|
|
2786
|
-
"summary": "
|
|
2725
|
+
"summary": "Username or alias of the DevOps Center org.",
|
|
2726
|
+
"hasDynamicHelp": true,
|
|
2727
|
+
"multiple": false,
|
|
2728
|
+
"type": "option"
|
|
2729
|
+
},
|
|
2730
|
+
"tests": {
|
|
2731
|
+
"char": "t",
|
|
2732
|
+
"description": "Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains spaces.",
|
|
2733
|
+
"name": "tests",
|
|
2734
|
+
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
2787
2735
|
"hasDynamicHelp": false,
|
|
2736
|
+
"multiple": true,
|
|
2737
|
+
"type": "option"
|
|
2738
|
+
},
|
|
2739
|
+
"test-level": {
|
|
2740
|
+
"char": "l",
|
|
2741
|
+
"description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more information, see the section \"Running Tests in a Deployment\" in the \"Metadata API Developer Guide\". (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm)",
|
|
2742
|
+
"name": "test-level",
|
|
2743
|
+
"summary": "Deployment Apex testing level.",
|
|
2744
|
+
"hasDynamicHelp": false,
|
|
2745
|
+
"multiple": false,
|
|
2746
|
+
"options": [
|
|
2747
|
+
"NoTestRun",
|
|
2748
|
+
"RunSpecifiedTests",
|
|
2749
|
+
"RunLocalTests",
|
|
2750
|
+
"RunAllTestsInOrg"
|
|
2751
|
+
],
|
|
2752
|
+
"type": "option"
|
|
2753
|
+
},
|
|
2754
|
+
"async": {
|
|
2755
|
+
"description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"sf project deploy pipeline resume\". To check the status of the deployment, run \"sf project deploy pipeline report\".",
|
|
2756
|
+
"name": "async",
|
|
2757
|
+
"summary": "Run the command asynchronously.",
|
|
2758
|
+
"allowNo": false,
|
|
2759
|
+
"type": "boolean"
|
|
2760
|
+
},
|
|
2761
|
+
"wait": {
|
|
2762
|
+
"char": "w",
|
|
2763
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"sf project deploy pipeline report\".",
|
|
2764
|
+
"exclusive": [
|
|
2765
|
+
"async"
|
|
2766
|
+
],
|
|
2767
|
+
"name": "wait",
|
|
2768
|
+
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
2769
|
+
"default": "33 minutes",
|
|
2770
|
+
"hasDynamicHelp": true,
|
|
2771
|
+
"helpValue": "<minutes>",
|
|
2788
2772
|
"multiple": false,
|
|
2789
2773
|
"type": "option"
|
|
2774
|
+
},
|
|
2775
|
+
"verbose": {
|
|
2776
|
+
"name": "verbose",
|
|
2777
|
+
"summary": "Show verbose output of the command result.",
|
|
2778
|
+
"allowNo": false,
|
|
2779
|
+
"type": "boolean"
|
|
2780
|
+
},
|
|
2781
|
+
"concise": {
|
|
2782
|
+
"exclusive": [
|
|
2783
|
+
"verbose"
|
|
2784
|
+
],
|
|
2785
|
+
"name": "concise",
|
|
2786
|
+
"summary": "Show concise output of the command result.",
|
|
2787
|
+
"allowNo": false,
|
|
2788
|
+
"type": "boolean"
|
|
2790
2789
|
}
|
|
2791
2790
|
},
|
|
2792
2791
|
"hasDynamicHelp": true,
|
|
2793
2792
|
"hiddenAliases": [],
|
|
2794
|
-
"id": "
|
|
2793
|
+
"id": "project:deploy:pipeline:validate",
|
|
2795
2794
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2796
2795
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
2797
2796
|
"pluginType": "core",
|
|
2797
|
+
"state": "beta",
|
|
2798
2798
|
"strict": true,
|
|
2799
|
-
"summary": "
|
|
2799
|
+
"summary": "Perform a validate-only deployment from a branch to the pipeline stage’s org.",
|
|
2800
2800
|
"enableJsonFlag": true,
|
|
2801
2801
|
"isESM": true,
|
|
2802
2802
|
"relativePath": [
|
|
2803
2803
|
"lib",
|
|
2804
2804
|
"commands",
|
|
2805
|
-
"
|
|
2806
|
-
"
|
|
2807
|
-
"
|
|
2808
|
-
"
|
|
2805
|
+
"project",
|
|
2806
|
+
"deploy",
|
|
2807
|
+
"pipeline",
|
|
2808
|
+
"validate.js"
|
|
2809
2809
|
]
|
|
2810
2810
|
}
|
|
2811
2811
|
},
|
|
2812
|
-
"version": "2.3.
|
|
2812
|
+
"version": "2.3.6"
|
|
2813
2813
|
}
|