> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# appzung/codepush-deploy

This orb installs the AppZung CLI and uses it to deploy your React Native update to AppZung CodePush. This way, your new features or bug fixes will become available to your users much earlier than if you were going through the app store reviews, and development iterations are much faster. Sign up first at https://appzung.com


## Commands

### deploy_react_native

Deploy a React Native update to AppZung CodePush.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `api_key` | string |  | AppZung API key for authentication. An API key that has access to this project. |
| `description_from_git` | boolean | false | Use the current git commit message as the release description |
| `disabled` | boolean | false | Specifies whether this release should be disabled (not immediately available, can be enabled later) |
| `extra_flags` | string |  | Any additional command line flags you want to pass to the deploy command. Example: '--disable-duplicate-release-error --use-hermes' |
| `mandatory` | boolean | false | Specifies whether this release should be considered mandatory |
| `private_key_path` | string |  | Specifies the location of a private key to sign the release with. This should be a path relative to your project root. |
| `release_channel` | string |  | The release channel ID to deploy to (eg. 'myReleaseChannelDescription/c95d7950-228c-4f47-8abb-4e275050ca8e') |
| `rollout` | string |  | Percentage points of users this release should be available to (eg. 95 for 95%) |
| `target_binary_version` | string |  | Semver version that specifies the binary app version this release is compatible with. If left unspecified, it will try to find the correct version. |
| `working_directory` | string | . | Directory from which to run the deploy command, useful for monorepos or projects with non-standard structure |

## Jobs

### deploy_react_native

Deploy a React Native update to AppZung CodePush. This job installs the AppZung CLI and uses it to deploy your React Native update to AppZung CodePush.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `api_key` | string |  | AppZung API key for authentication. An API key that has access to this project. |
| `description_from_git` | boolean | false | Use the current git commit message as the release description |
| `disabled` | boolean | false | Specifies whether this release should be disabled (not immediately available, can be enabled later) |
| `extra_flags` | string |  | Any additional command line flags you want to pass to the deploy command. Example: '--disable-duplicate-release-error --use-hermes' |
| `install_dependencies` | boolean | true | Whether to install dependencies before deploying |
| `mandatory` | boolean | false | Specifies whether this release should be considered mandatory |
| `node_version` | string | lts | Node.js version to use for deployment |
| `package_manager` | enum | npm | Package manager to use for installing dependencies |
| `private_key_path` | string |  | Specifies the location of a private key to sign the release with. This should be a path relative to your project root. |
| `release_channel` | string |  | The release channel ID to deploy to (eg. 'myReleaseChannelDescription/c95d7950-228c-4f47-8abb-4e275050ca8e') |
| `rollout` | string |  | Percentage points of users this release should be available to (eg. 95 for 95%) |
| `target_binary_version` | string |  | Semver version that specifies the binary app version this release is compatible with. If left unspecified, it will try to find the correct version. |
| `working_directory` | string | . | Directory from which to run the deploy command, useful for monorepos or projects with non-standard structure |

## Executors

### default

This is an executor using Docker and Node.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `node_version` | string | lts | Pick a specific cimg/node image variant: https://hub.docker.com/r/cimg/node/tags
 |

## Examples

### deploy_react_native

Deploy a React Native update to AppZung CodePush.


```yaml
version: '2.1'
orbs:
  codepush-deploy: appzung/codepush-deploy@1.0
workflows:
  deploy-react-native-update:
    jobs:
      - codepush-deploy/deploy_react_native:
          api_key: ${APPZUNG_API_KEY}
          description_from_git: true
          disabled: false
          install_dependencies: true
          mandatory: false
          node_version: lts
          package_manager: yarn
          release_channel: Production/c95d7950-228c-4f47-8abb-4e275050ca8e
          rollout: '100'
```