Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 94 additions & 0 deletions steps/deploypulse-codepush-release-react-native/0.0.3/step.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
title: AppCenter CodePush Release React Native
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
title: AppCenter CodePush Release React Native
title: Release React Native with DeployPulse / AppCenter

Suggesting slightly more readable title.

summary: |
Release a React Native update to AppCenter CodePush
description: |
Utilise appcenter-cli command appcenter codepush release-react to release an update
website: https://github.com/elevationsoftwareio/bitrise-step-appcenter-codepush-release-react-native
source_code_url: https://github.com/elevationsoftwareio/bitrise-step-appcenter-codepush-release-react-native
support_url: https://github.com/elevationsoftwareio/bitrise-step-appcenter-codepush-release-react-native/issues
published_at: 2025-02-19T16:48:13.627253-05:00
source:
git: https://github.com/elevationsoftwareio/bitrise-step-appcenter-codepush-release-react-native.git
commit: c3e68f7f3287a54c9da0ab1bbf63bc34b04d270f
host_os_tags:
- osx-10.11
- ubuntu-16.04
project_type_tags:
- react-native
type_tags:
- deploy
toolkit:
bash:
entry_file: step.sh
deps:
brew:
- name: node
apt_get:
- name: node
is_requires_admin_user: true
is_always_run: false
is_skippable: false
run_if: ""
inputs:
- opts:
description: |
Path where the React Native project is located.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add summary for all inputs. To check that they are displayed correctly you can use (bitrise :workflow-editor command locally)

is_required: true
title: React Native Project Root
react_native_project_root: $REACT_NATIVE_PROJECT_ROOT
- app_id: $APP_ID
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please do not use environment variables as the default value.

See our docs https://devcenter.bitrise.io/en/steps-and-workflows/developing-your-own-bitrise-step/developing-a-new-step.html:
Environment Variables must not be used as default values, unless:

  • They are exposed by the Bitrise CLI or by bitrise.io.
  • They are generated as an output by another Step (for example, $BITRISE_IPA_PATH, $BITRISE_AAB_PATH).

opts:
description: |
The name of the app as it appears in the DeployPulse dashboard. You will need a valid api token to authenticate with DeployPulse.
is_required: true
summary: DeployPulse application identifier (App Name).
title: Your App ID
- api_token: $API_TOKEN
opts:
description: |
API Tokens can be obtained from following steps [here](https://docs.deploypulse.io/quickstart#registering-and-login).
is_required: true
is_sensitive: true
title: API Token
- deployment: Staging
opts:
description: |
This specifies which deployment you want to release the update to. This defaults to Staging, but when you're ready to deploy to Production, or one of your own custom deployments, just explicitly set this argument. See [here](https://docs.microsoft.com/en-us/appcenter/distribution/codepush/cli#deployment-name-parameter) for details.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Linking to appcenter docs is still alright, but would recommend migrating away in a next Step release as it may be removed with App Center deprecation.

is_required: true
title: Deployment
- opts:
description: |
The platform you want to release the update to. This defaults to ios, but you can specify android if you want to release to the Android platform.
is_required: true
title: Platform
platform: ios
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I beleive you can use value_options to specify list on valid inputs (ios, android).

- opts:
description: |
The binary version of the app you are releasing the update for. This is required when releasing an update for a specific binary version of your app, and it is recommended that you always specify this argument.
is_required: false
title: Target Binary Version
target_binary_version: null
- description: null
opts:
description: |
Specify an optional "change log" for the deployment.
is_required: false
title: Description
- opts:
description: |
It is the distribution percentage (0 - 100) of your new update in codepush, by default it is 100% of the users
is_required: true
title: Rollout Percentage
percentage: 100
- opts:
description: |
To sign your new update in codepush, '$SIGN_PRIVATE_KEY' must be the one who stores your private key to sign
is_required: false
title: Signed update
private_key: -k $SIGN_PRIVATE_KEY
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could make this input easier to use with Bitrise.

  • The easiest to use option would be to accept a remote URL as an input (optionally a local file path too). That way the input can be set on the UI using generic file storage as a source (And fetched using wget in the step.sh https://devcenter.bitrise.io/en/builds/managing-build-files/using-files-in-your-builds.html). Would also remove the -k flag and move it to the step.sh instead.
  • Keep the local file path requirement, but would add a description on how can use file-downloader or Script step to fetch the key file.

- options: null
opts:
description: |
Any extra options that you would like to concat to the release-react command. Eg. "-m --disable-duplicate-release-error"
is_required: false
title: Extra Options
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
maintainer: community