Skip to content

Commit

Permalink
feat(cleanup): cleanup existing commands description and remove depre…
Browse files Browse the repository at this point in the history
…cated commands

This change removes all the deprecated commands in dxatscale's version of sfp, fixes the description
of the commands

BREAKING CHANGE: orchestrator topic is deprecated, use orchestrator commands without orchestrator
topic directly such as sfp:build
  • Loading branch information
azlam-abdulsalam committed Feb 23, 2024
1 parent a3cede0 commit f01284c
Show file tree
Hide file tree
Showing 29 changed files with 12 additions and 2,488 deletions.
2 changes: 1 addition & 1 deletion packages/sfp-cli/messages/build.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"commandDescription": "Build all packages (unlocked/source/data) in a repo in parallel, respecting the dependency of each packages and generate artifacts to a provided directory",
"commandDescription": "Build artifacts of your packages in the current project",
"devhubAliasFlagDescription": "Provide the alias of the devhub previously authenticated, default value is HubOrg if using the Authenticate Devhub task",
"diffCheckFlagDescription": "Only build the packages which have changed by analyzing previous tags",
"gitTagFlagDescription": "Tag the current commit ID with an annotated tag containing the package name and version - does not push tag",
Expand Down
2 changes: 1 addition & 1 deletion packages/sfp-cli/messages/deploy.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"commandDescription": "Deploy packages from the provided aritfact directory, to a given org, using the order and configurable flags provided in sfdx-project.json",
"commandDescription": "Deploy artifacts from a given directory to a target org",
"targetOrgFlagDescription": "Alias/User Name of the target environment",
"artifactDirectoryFlagDescription": "The directory containing artifacts to be deployed",
"waitTimeFlagDescription": "Wait time for command to finish in minutes",
Expand Down
2 changes: 1 addition & 1 deletion packages/sfp-cli/messages/fetch.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"commandDescription": "Fetch artifacts from an artifact registry that is either NPM compatible or supports universal artifacts",
"commandDescription": "Fetch sfp artifacts from a NPM compatible registry using a release definition file",
"releaseDefinitionFlagDescription": "Path to YAML file containing map of packages and package versions to download",
"artifactDirectoryFlagDescription": "Directory to save downloaded artifacts",
"scriptPathFlagDescription": "(Optional: no-NPM) Path to script that authenticates and downloads artifacts from the registry",
Expand Down
2 changes: 1 addition & 1 deletion packages/sfp-cli/messages/patch.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"commandDescription": "[Alpha] Patch a branch in the repository as per the release definition and create a new branch",
"commandDescription": "Generate a dynamic branch with the packages patched to the contents as mentioned in the release config file",
"releaseDefinitionFlagDescription": "Path to release definiton yaml",
"sourcebranchNameFlagDescription": "Name of the source branch to be used on which the alignment need to be applied",
"targetbranchNameFlagDescription": "Name of the target branch to be created after the alignment",
Expand Down
2 changes: 1 addition & 1 deletion packages/sfp-cli/messages/profile_merge.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"commandDescription": "This command is used in the lower environments such as ScratchOrgs , Development / System Testing Sandboxes, inorder to apply the changes made in the environment to retrieved profile, so that it can be deployed to the higher environments",
"commandDescription": "Merge changes made in the profile directly in the org to the profile files in the local project",
"folderFlagDescription": "comma separated list of folders to scan for profiles. If ommited, the folders in the packageDirectories configuration will be used.",
"profileListFlagDescription": "comma separated list of profiles. If ommited, all the profiles found in the folder(s) will be merged",
"metadataFlagDescription": "comma separated list of metadata for which the permissions will be retrieved.",
Expand Down
2 changes: 1 addition & 1 deletion packages/sfp-cli/messages/profile_reconcile.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"commandDescription": "This command is used in the lower environments such as ScratchOrgs , Development / System Testing Sandboxes, where a retrieved profile from production has to be cleaned up only for the metadata that is contained in the environment or base it only as per the metadata that is contained in the packaging directory.",
"commandDescription": "Reconcile profiles in the local directory only with the attributes that are available in the target org",
"folderFlagDescription": "path to the folder which contains the profiles to be reconciled,if project contain multiple package directories, please provide a comma seperated list, if omitted, all the package directories will be checked for profiles",
"nameFlagDescription": "list of profiles to be reconciled. If ommited, all the profiles components will be reconciled.",
"destFolderFlagDescription": " the destination folder for reconciled profiles, if omitted existing profiles will be reconciled and will be rewritten in the current location",
Expand Down
2 changes: 1 addition & 1 deletion packages/sfp-cli/messages/publish.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"commandDescription": "Publish packages to an artifact registry, using a user-provided script that is responsible for authenticating & uploading to the registry.",
"commandDescription": "Publish packages to a NPM Compatible artifact registry",
"artifactDirectoryFlagDescription": "The directory containing artifacts to be published",
"publishPromotedOnlyFlagDescription": "Only publish unlocked packages that have been promoted",
"devhubAliasFlagDescription": "Provide the alias of the devhub previously authenticated",
Expand Down
2 changes: 1 addition & 1 deletion packages/sfp-cli/messages/quickbuild.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"commandDescription": "Build packages (unlocked/source/data) in a repo in parallel, without validating depenencies or coverage in the case of unlocked packages",
"commandDescription": "Build artifacts of your packages in the current project without dependency validation for unlocked packages",
"devhubAliasFlagDescription": "Provide the alias of the devhub previously authenticated, default value is HubOrg if using the Authenticate Devhub task",
"diffCheckFlagDescription": "Only build the packages which have changed by analyzing previous tags",
"gitTagFlagDescription": "Tag the current commit ID with an annotated tag containing the package name and version - does not push tag",
Expand Down
2 changes: 1 addition & 1 deletion packages/sfp-cli/messages/release.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"commandDescription": "Release a collection of artifacts as defined in the release definition file",
"commandDescription": "Deploy a release definition to a target org",
"releaseDefinitionFlagDescription": "Path to release definiton yaml, Multiple paths can be seperated by commas",
"targetOrgFlagDescription": "Alias/User Name of the target environment",
"scriptPathFlagDescription": "(Optional: no-NPM) Path to script that authenticates and downloads artifacts from the registry",
Expand Down
2 changes: 1 addition & 1 deletion packages/sfp-cli/messages/releasedefinition_generate.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"commandDescription": "Generates release definition based on the artifacts installed from a commit reference",
"commandDescription": "Generates release definition based on the artifacts at the specified head of source branch/commit ref",
"configFileFlagDescription":"Path to the release config file which determines how the release definition should be generated",
"releaseNameFlagDescription": "Set a release name on the release definition file created",
"commitFlagDescription": "Utilize the tags on the source branch to generate release definiton",
Expand Down
2 changes: 1 addition & 1 deletion packages/sfp-cli/messages/validate.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"commandDescription": "Validate the incoming change against an earlier prepared scratchorg",
"commandDescription": "Build and Validate a set of artifacts against an enviroments prepared by Prepare Command",
"devhubUsernameFlagDescription": "Authentication username for Dev Hub",
"poolsFlagDescription": "Fetch scratch-org validation environment from one of listed pools, sequentially",
"configFileFlagDescription":"(Required if the release modes are ff-relese-config or thorough-release-config), Path to the config file which determines how the release defintion should be generated",
Expand Down
2 changes: 1 addition & 1 deletion packages/sfp-cli/messages/validateAgainstOrg.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"commandDescription": "Validate the incoming change against target org",
"commandDescription": "Build and Validate a set of artifacts against a provided org",
"targetOrgFlagDescription": "Alias/User Name of the target environment",
"coveragePercentFlagDescription": "Minimum required percentage coverage for validating code coverage of packages with Apex classes",
"logsGroupSymbolFlagDescription": "Symbol used by CICD platform to group/collapse logs in the console. Provide an opening group, and an optional closing group symbol.",
Expand Down
3 changes: 0 additions & 3 deletions packages/sfp-cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,6 @@
"releasedefinition": {
"description": "Commands around release definition"
},
"orchestrator": {
"description": "[Deprecated] Orchestrate packages from a monorepo through its lifecycle, driven by descriptors in your sfdx-project.json"
},
"pool": {
"description": "Manage the pooled orgs created by the sfp orchestrator in prepare stage"
},
Expand Down
45 changes: 0 additions & 45 deletions packages/sfp-cli/src/commands/orchestrator/build.ts

This file was deleted.

168 changes: 0 additions & 168 deletions packages/sfp-cli/src/commands/orchestrator/deploy.ts

This file was deleted.

Loading

0 comments on commit f01284c

Please sign in to comment.