Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: add summary field to org flags #137

Merged
merged 3 commits into from
Nov 17, 2022
Merged

fix: add summary field to org flags #137

merged 3 commits into from
Nov 17, 2022

Conversation

cristiand391
Copy link
Member

@cristiand391 cristiand391 commented Nov 17, 2022

This PR adds flag descriptions to all the sfdx org flags. Consumers can't set properties so the flags always showed up without a desc in the help text.

top: latest sf-plugins-core using requiredOrgFlagWithDeprecations flag
bottom: requiredOrgFlagWithDeprecations with desc
Screen Shot 2022-11-17 at 14 59 20

[skip-validate-pr]

@cristiand391 cristiand391 changed the title fix: add desc to sfdx org flags fix: add summary field to org flags Nov 17, 2022
@mshanemc
Copy link
Contributor

QA notes:

works in yarn-linked plugin-data

before

➜  ~ sf data create record -h
creates and inserts a record

USAGE
  $ sf data create record -s <value> -v <value> [--json] [-o <value>] [--api-version <value>] [-t]

FLAGS
  -o, --target-org=<value>
  -s, --sobject=<value>     (required) the type of the record you’re creating
  -t, --use-tooling-api     create the record with tooling api
  -v, --values=<value>      (required) the <fieldName>=<value> pairs you’re creating
  --api-version=<value>     Override the api version used for api requests made by this command

✅ after

➜ plugin-data git:(sm/sf-ification) ./bin/dev data:create:record -o shane.mclaughlin@dxhub.org --help
creates and inserts a record

USAGE
$ sfdx data:create:record -s -v [--json] [-o ] [--api-version ] [-t]

FLAGS
-o, --target-org= Username or alias of the target org.
-s, --sobject= (required) the type of the record you’re creating
-t, --use-tooling-api create the record with tooling api
-v, --values= (required) the = pairs you’re creating
--api-version= Override the api version used for api requests made by this command


see also code-search links on https://github.com/salesforcecli/sf-plugins-core/pull/136 for validation that all our code sets summary when using this flag so this change doesn't change them.

@mshanemc mshanemc merged commit 936dea0 into main Nov 17, 2022
@mshanemc mshanemc deleted the cd/target-org-summary branch November 17, 2022 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants