microsoft / code-push

A cloud service that enables Cordova and React Native developers to deploy mobile app updates directly to their users’ devices.
https://microsoft.github.io/code-push/
Other
4.36k stars 495 forks source link

Typo in the docs regarding code signing #670

Closed luisnaranjo733 closed 4 years ago

luisnaranjo733 commented 4 years ago

The docs claim that the CLI param for specifying the path to the private key is --privateKeyPath.

In reality, it appears to be --private-key-path.

C:\Users\jonaranj\Downloads>yarn appcenter codepush release --help
yarn run v1.12.3
warning package.json: No license field
$ C:\Users\jonaranj\Downloads\node_modules\.bin\appcenter codepush release --help

Release an update to an app deployment

Usage: appcenter codepush release -t|--target-binary-version <arg> -c|--update-contents-path <arg> [-r|--rollout <arg>] [--disable-duplicate-release-error] [-k|--private-key-path <arg>] [-m|--mandatory] [-x|--disabled]
         [--description <arg>] [-d|--deployment-name <arg>] [-a|--app <arg>]

Options:
    -t|--target-binary-version <arg>                 Semver expression that specifies the binary app version(s) this release is targeting (e.g. 1.1.0, ~1.2.3)
    -c|--update-contents-path <arg>                  Path to update contents folder
    -r|--rollout <arg>                               Percentage of users this release should be available to
       --disable-duplicate-release-error             When this flag is set, releasing a package that is identical to the latest release will produce a warning instead of an error
    -k|--private-key-path <arg>                      Specifies the location of a RSA private key to sign the release with.NOTICE: use it for react native applications only, client SDK on other platforms will be ignoring signature
                                                     verification for now!
    -m|--mandatory                                   Specifies whether this release should be considered mandatory
    -x|--disabled                                    Specifies whether this release should be immediately downloadable
       --description <arg>                           Description of the changes made to the app in this release
    -d|--deployment-name <arg>                       Deployment to release the update to
    -a|--app <arg>                                   Specify app in the <ownerName>/<appName> format

Common Options (works on all commands):
       --disable-telemetry             Disable telemetry for this command
    -v|--version                       Display appcenter version
       --quiet                         Auto-confirm any prompts without waiting for input
    -h|--help                          Display help for current command
       --env <arg>                     Environment when using API token
       --token <arg>                   API token
       --output <arg>                  Output format: json
       --debug                         Display extra output for debugging
Done in 3.42s.
luisnaranjo733 commented 4 years ago
C:\Users\jonaranj\Downloads>yarn appcenter --version
yarn run v1.12.3
warning package.json: No license field
$ C:\Users\jonaranj\Downloads\node_modules\.bin\appcenter --version
appcenter version 2.3.0
Done in 2.47s.
alexandergoncharov-zz commented 4 years ago

Hi @luisnaranjo733 , Thanks for reporting!

Please note that code-push and appcenter are the different cli apps. For code-push(depricated) cli it is privateKeyPath. For appcenter cli it is private-key-path. Our recommendation is to use appcenter cli. I hope it was helpful for you.

I'm going to close this issue for now. Please feel free to reopen it if you have any questions.

MathieuUrstein commented 2 years ago

--privateKeyPath can still be found here: https://docs.microsoft.com/en-us/appcenter/distribution/codepush/cli