Fastlane Buildstash Plugin

Overview

The fastlane-plugin-buildstash plugin allows you to upload build artifacts to Buildstash seamlessly as part of your Fastlane workflow. This plugin ensures that your builds are efficiently stored and accessible for further processing.

Installation

You can install this plugin to your project running:

Preferred installation method

fastlane add_plugin buildstash

Testing locally

Or, to use a copy of this plugin locally, add it to your Pluginfile:

gem 'fastlane-plugin-buildstash', path: '/path/to/fastlane-plugin-buildstash'

Then run:

bundle install

Usage

To upload an artifact to Buildstash, use the buildstash_upload action in your Fastfile.

With base required parameters:

buildstash_upload(
  api_key: 'BUILDSTASH_APP_API_KEY',
  primary_file_path: './path/to/file.apk',
  platform: 'android',
  stream: 'default',
  version_component_1_major: 0,
  version_component_2_minor: 0,
  version_component_3_patch: 1
)

or with all input parameters:

lane :run_buildstash_upload do |options|
  buildstash_upload(
    api_key: options[:api_key],
    structure: 'file',
    primary_file_path: './path/to/file.apk',
    platform: 'android',
    stream: 'default',
    version_component_1_major: 0,
    version_component_2_minor: 0,
    version_component_3_patch: 1,
    version_component_extra: 'rc',
    version_component_meta: '2024.12.01',
    custom_build_number: '12345',
    notes: '<AppChangelog>',
    source: 'ghactions',
    ci_pipeline: options[:ci_pipeline],
    ci_run_id: options[:ci_run_id],
    ci_run_url: options[:ci_run_url],
    vc_host_type: 'git',
    vc_host: 'github',
    vc_repo_name: options[:vc_repo_name],
    vc_repo_url: options[:vc_repo_url],
    vc_branch: options[:vc_branch],
    vc_commit_sha: options[:vc_commit_sha],
    vc_commit_url: options[:vc_commit_url]
  )
end

Parameters

Parameter	Description	Required
`api_key`	The API key for authentication	✅
`structure`	'file' for single file, 'file+expansion' to include Android expansion file. will default to 'file'	✖
`primary_file_path`	'./path/to/file.apk'	✅
`platform`	'android' or 'ios' (see Buildstash docs for full list)	✅
`stream`	Exact name of a build stream in your app	✅
`version_component_1_major`	Semantic version (major component)	✅
`version_component_2_minor`	Semantic version (minor component)	✅
`version_component_3_patch`	Semantic version (patch component)	✅
`version_component_extra`	Optional pre-release label (beta, rc1, etc)	✖
`version_component_meta`	Optional release metadata	✖
`custom_build_number`	Optional custom build number in any format	✖
`notes`	Changelog or additional notes	✖️
`source`	Where build was produced (`ghactions`, `jenkins`, etc) defaults to cli-upload	✖️
`ci_pipeline`	CI pipeline name	✖️
`ci_run_id`	CI run ID	✖️
`ci_run_url`	CI run URL	✖️
`vc_host_type`	Version control host type (git, svn, hg, perforce, etc)	✖️
`vc_host`	Version control host (github, gitlab, etc)	✖️
`vc_repo_name`	Repository name	✖️
`vc_repo_url`	Repository URL	✖️
`vc_branch`	Branch name (if applicable)	✖️
`vc_commit_sha`	Commit SHA (if applicable)	✖️
`vc_commit_url`	Commit URL	✖️

Example Output

When the upload is successful, you will see:

[✔] Upload to Buildstash successful!

If the file does not exist, an error will be raised:

[✗] File not found at path: non_existent_file.apk

Outputs

The buildstash_upload action stores the following outputs in lane_context for in subsequent actions:

Key	Description
`BUILDSTASH_BUILD_ID`	The build ID in Buildstash for the uploaded build
`BUILDSTASH_INFO_URL`	Link to view uploaded build within Buildstash workspace
`BUILDSTASH_DOWNLOAD_URL`	Link to download the build uploaded to Buildstash (requires login)

For example, to see these values output:

lane :test_plugin do |options|
  buildstash_upload(
    api_key: options[:api_key],
    primary_file_path: "ponderpad.ipa",
    platform: "ios",
    stream: "default",
    version_component_1_major: 1,
    version_component_2_minor: 0,
    version_component_3_patch: 1
  )
  
  # Output to terminal
  UI.message("🔧 Buildstash Build ID: #{lane_context[:BUILDSTASH_BUILD_ID]}")
  UI.message("🔗 Build Info URL: #{lane_context[:BUILDSTASH_INFO_URL]}")
  UI.message("📦 Download URL: #{lane_context[:BUILDSTASH_DOWNLOAD_URL]}")
end

Testing

To run tests:

bundle exec rspec

Contributing

Fork the repository.
Create a new branch (feature/my-feature).
Commit your changes.
Push to the branch and create a Merge Request.

Contributions are welcome.

Support

For issues and feature requests, please contact the internal development team or submit an issue on GitLab.

Thanks

Credit to Yann Miecielica and the team at Gimbal Cube for contributions to this plugin.

fastlane-plugin-buildstash

Development