GitLab CI/CD

Ship on Every GitLab Pipeline Run

Q: Where does the AppShare job go?

In your existing .gitlab-ci.yml, as a new job assigned to whichever stage makes sense in your pipeline.

Q: What triggers the release job?

Whatever you define under rules or only/except, a push to a specific branch, a merge request pipeline, or a tag, it's entirely up to your configuration.

Q: Can I trigger this from a merge request pipeline instead of a branch push?

Yes, adjust the rules block to match on merge request events instead of $CI_COMMIT_BRANCH.

Q: Can I add release notes automatically?

Yes, using the --notes flag on the upload command, either a static string or a value built from a predefined GitLab CI/CD variable like the commit message.

Add a job to your `.gitlab-ci.yml`, and any pipeline that reaches it pushes a build to AppShare, no separate step for anyone to remember.

Start Free

What You Get

Three Reasons Teams Automate This Job

One File, Every Merge

Add a single job to the .gitlab-ci.yml you already have, and it applies to every pipeline run from then on.

Runs on the Runner You Already Use

Whether you're on GitLab.com's shared runners or a self-managed instance, the release job runs on the same runner as the rest of your pipeline.

Control Exactly When It Fires

GitLab's rules keyword lets you decide precisely which branch, tag, or event triggers the release, not just "every push."

SETUP

Add AppShare to Your Pipeline

Follow these four steps to automate your mobile distribution on every merge or pipeline run.

Open your .gitlab-ci.yml

Step 1

Find the file at your repo root or create one if this is your first pipeline.

Add a masked CI/CD variable

Secret

In Settings → CI/CD → Variables, add APPSHARE_API_KEY as a masked variable.

Add the upload job

Pipeline

Add the upload_to_appshare job to execute when your pipeline passes.

Commit & Push

Deploy

Push your changes to trigger your first automated build and distribution.

Step 1 of 4

Step 1

Open your .gitlab-ci.yml

Open your repository's .gitlab-ci.yml at the project root. Ensure your pipeline defines the build and release stages.

.gitlab-ci.yml

stages:
  - build
  - release

# Your existing build job produces the APK/IPA artifact
build_app:
  stage: build
  script:
    - ./gradlew assembleRelease
  artifacts:
    paths:
      - app/build/outputs/apk/release/*.apk

Ensure your build step exports artifacts so the release job can access them.

LIFECYCLE

What Actually Happens on a Push

Pipeline Starts

A push, merge request, or scheduled run kicks off the pipeline defined in your .gitlab-ci.yml

Runner Builds the App

A GitLab Runner picks up the job once earlier stages pass, and runs the real build command, producing the actual file.

AppShare CLI Installs

The job's script installs AppShare CLI fresh, right after that build command.

Build Gets Pushed

The CLI reads the masked variable and uploads the file the build step just produced.

UNDER THE HOOD

GitLab Just Runs the CLI

That script step is just AppShare CLI, running inside your pipeline instead of your terminal.

SEE CLI SETUP

Other Platforms

AppShare Works With Your Pipeline Too

GitHub Actions

Trigger a release directly from a workflow file, on push, pull request, or tag.

Learn More

Bitrise

Drop AppShare into a Bitrise workflow as a step, right alongside your existing build and test stages.

Learn More

Jenkins

Add an AppShare step to a Jenkins pipeline, scripted or declarative.

Learn More

CircleCI

Push a build from a CircleCI job as part of your existing config.

Learn More

Xcode Cloud

Trigger an AppShare release from an Xcode Cloud workflow, without leaving Apple's own CI environment.

Learn More

Fastlane

Add an AppShare lane to your existing Fastfile, alongside your build and signing steps.

Learn More

FAQ

Questions About the GitLab CI/CD Integration

Where does the AppShare job go?

In your existing .gitlab-ci.yml, as a new job assigned to whichever stage makes sense in your pipeline.

What triggers the release job?

Whatever you define under rules or only/except, a push to a specific branch, a merge request pipeline, or a tag, it's entirely up to your configuration.

Can I trigger this from a merge request pipeline instead of a branch push?

Yes, adjust the rules block to match on merge request events instead of $CI_COMMIT_BRANCH.

Does this work for both Android and iOS builds?

The script doesn't care which platform it's uploading. Point appshare-cli upload at an .apk or an .ipa and it behaves the same either way.

Is GitLab CI/CD integration included on the Free plan?

It's part of CI/CD access generally, available from the Free plan up, not gated behind a specific tier.

How do I keep my API key out of the YAML file?

Add it as a CI/CD variable in Settings → CI/CD → Variables, set to Masked, and reference it in your script as $APPSHARE_API_KEY.

Do I need a specific GitLab Runner for this?

No. It runs as a standard script job, so any runner capable of running shell commands and Node-based tools works.

Can I add release notes automatically?

Yes, using the --notes flag on the upload command, either a static string or a value built from a predefined GitLab CI/CD variable like the commit message.