Skip to content

SFDX plugin to set up a connected app usable for continuous integration with "one click"

Notifications You must be signed in to change notification settings

fransflippo/sfdx-ci-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

sfdx-ci-plugin

SFDX plugin to set up a connected app usable for continuous integration with "one click".

This plugin simplifies the process of creating a connected app that you can use with sfdx auth:jwt:grant to non-interactively connect SFDX to a sandbox or production org so that you can deploy your SFDX project. It:

  • creates an RSA private key and an X.509 certificate
  • creates a permission set that controls access to the connected app
  • creates the connected app and configures it with the X.509 certificate for digital signatures and connects it to the permission set

After this, you can connect to the org with a single command:

sfdx auth:jwt:grant -u user@example.org -f privkey.pem -i <OAuth client id>

Version Codecov Known Vulnerabilities Downloads/week License

$ npm install -g @assisisolutions/sfdx-ci-plugin
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
@assisisolutions/sfdx-ci-plugin/1.0.1 darwin-x64 node-v15.4.0
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...

sfdx ci:setup [-n <string>] [-p <string>] [-f] [-c <filepath>] [-d <directory>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Sets up an org as the target of a continuous integration pipeline

Sets up an org as the target of a continuous integration pipeline

USAGE
  $ sfdx ci:setup [-n <string>] [-p <string>] [-f] [-c <filepath>] [-d <directory>] [-u <string>] [--apiversion 
  <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -c, --certfile=certfile
      path to the X.509 certificate to configure the connected app to use for authentication

  -d, --outputdir=outputdir
      [default: .] path to which the X.509 certificate and private key file will be written

  -f, --force
      overwrite an existing connected app

  -n, --name=name
      [default: Continuous Integration] name of the connected app to create

  -p, --permissionsetname=permissionsetname
      name of the permission set that will determine which users have access to the connected app. If not provided, the 
      permission set will have the same name as the connected app. In either case, the permission set is created if it 
      doesn't exist yet.

  -u, --targetusername=targetusername
      username or alias for the target org; overrides default target org

  --apiversion=apiversion
      override the api version used for api requests made by this command

  --json
      format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)
      [default: warn] logging level for this command invocation

EXAMPLES
  $ sfdx ci:setup --targetusername myOrg@example.com --name "Continuous Integration App" --permissionsetname "Admin 
  Access"
  $ sfdx ci:setup --targetusername myOrg@example.com --certfile mycert.pem

See code: lib/commands/ci/setup.js

About

SFDX plugin to set up a connected app usable for continuous integration with "one click"

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages