srcpush-github-action GitHub Action

Configures the Source Push Command Line Interface in the GitHub Actions environment.

Prerequisites

• This action runs using Node 20. If you are using self-hosted GitHub Actions runners, you must use a runner version that supports this version or newer.

Usage

GitHub action supports all the commands available in the Source Push CLI of appropriate version. Please keep in mind that some commands (such as release-react) need to be executed and make sense only after you have loaded all the dependencies of your project and build React Native app.

jobs:
  job_id:
    # Any runner supporting Node 20 or newer
    runs-on: ubuntu-latest
    steps:
      - name: Setup Source Push CLI
        uses: 'srcpush/srcpush-github-action@v1'
        id: setup-srcpush-cli
        with:
          version: 'latest'
          accessKey: ${{ secrets.SRCPUSH_ACCESS_KEY }}
      - name: Release Android bundle
        run: srcpush release-react myAmazingAndroidApp android -d Staging
      - name: Release ios bundle
        run: srcpush release-react myAmazingIOSApp ios -d Staging

Inputs

• version(Optional, default: latest). A string representing the version or version constraint of the Source Push CLI (srcpush) to install (e.g. "0.0.3" or ">= 0.0.2"). The default value is "latest", which will always download and install the latest available CLI version.

    - uses: 'srcpush/srcpush-github-action@v1'
      with:
        version: '>= 0.0.3'
  

  If there is no installed srcpush version that matches the given constraint, this GitHub Action will download and install the latest available version that still matches the constraint.

  You are responsible for ensuring the srcpush version matches the features required.

• accessKey(Optional). Source Push access key created in the app. Considered to be a secret.

     - uses: 'srcpush/srcpush-github-action@v1'
       with:
         accessKey: ${{ secrets.SRCPUSH_ACCESS_KEY }}
  

  You are responsible for ensuring the accessKey was not neither expired nor deleted.

  If no accessKey given you must authenticate CLI before executing any commands require authentication

    - name: Authenticate Source Push CLI
      run: srcpush login --accessKey ${{ secrets.SRCPUSH_ACCESS_KEY }}
  

Outputs

• version: Version of Source Push CLI that was installed.

Caching

Under the hood action uses @actions/tool-cache npm package to cache installed tooling (/opt/hostedtoolcache/srcpush) to speed up further workflow executions. It works out the box for self-hosted runners where for GitHub-hosted runners the following config is needed to persist changes made by action:

      - name: Tools cache
        id: tool-caches
        uses: actions/cache@v4
        with:
          path: /opt/hostedtoolcache/srcpush
          key: srcpush-${{ runner.os }}-${{ github.run_id }}
          restore-keys: |
            srcpush-${{ runner.os }}-

Versioning

We recommend pinning to the latest available major version:

- uses: 'srcpush/srcpush-github-action@v1'

While this action attempts to follow semantic versioning, human errors can occur. To avoid accidental breaking changes, you can pin to a specific version:

- uses: 'srcpush/srcpush-github-action@v1.0.0'

However, you will not get automatic security updates or new features without explicitly updating your version number.

Questions, Issues and Support

If you have any questions or issues with this action, please open an issue on this repository or send email to support@srcpush.com.