Buildstash

Get started

Integrations

If you’re using GitHub Actions sending your build artifacts into Buildstash is easy.<a href="https://docs.buildstash.com/integrations/ci/github#create-your-application-api-token" target="_blank" rel="noopener noreferrer nofollow" class="cursor-pointer box-border font-semibold border-b hover:border-b-[2px] transition-all duration-75 " style="text-decoration: none; color: inherit; border-color: var(--portal-accent-color);">​</a><h2>Create your application API token</h2><ol class="steps-list"><li>Create API token In your application settings, navigate to the “Connections” tab, and select “New Token”.<img src="https://uploads.productlane.com/5e7bab07467281fee4846c2d031233d1.png">Call the token anything you like - ideally something that helps you remember where it’s being used.</li><li>Safely store for use Your new API token will be shown.<img src="https://uploads.productlane.com/ff59d991e66c7ec63bf623150d9b6bcb.png">Note this is the only time the token will be shown, so be careful to record it securely (like in a password manager).</li></ol><h2><a href="https://docs.buildstash.com/integrations/ci/github#add-buildstash-action-to-your-workflow" target="_blank" rel="noopener noreferrer nofollow" class="cursor-pointer box-border font-semibold border-b hover:border-b-[2px] transition-all duration-75 " style="text-decoration: none; color: inherit; border-color: var(--portal-accent-color);">​</a>Add Buildstash action to your workflow</h2><ol class="steps-list"><li>Install Buildstash action Go to the <a href="https://github.com/marketplace/actions/buildstash" target="_blank" rel="noreferrer" class="cursor-pointer box-border font-semibold border-b hover:border-b-[2px] transition-all duration-75 " style="text-decoration: none; color: inherit; border-color: var(--portal-accent-color);">Buildstash action page on the GitHub Marketplace</a>.<img src="https://uploads.productlane.com/b6d3c278cf06f5f5eeade74fd594669a.png">You can copy and paste the provided code into your workflow yaml script.</li><li>Add API key to your 'Actions secrets' for the repository Take the Buildstash API key you created in the step above, and store it as a “Actions” secret.<img src="https://uploads.productlane.com/d3ec2c4bb243e04e51b0223f3d7db87a.png">Note, as you’ll be using an application-specific Buildstash API key (required to upload builds for particular app) you likely want to store this secret on your GitHub repository level, rather than workspace.</li><li>Tweak input values accordingly Update the action inputs to pass in your project and run specific values.See below for more detail on each input.</li><li>See your builds appear in Buildstash! Successful GitHub Actions runs will now be sending your builds into Buildstash. Welcome to artifact management actually designed for apps.<img src="https://uploads.productlane.com/18cda93acc09b98fe3af2ee116fd2702.png"></li></ol><h1></h1><h2><a href="https://docs.buildstash.com/integrations/ci/github#inputs" target="_blank" rel="noopener noreferrer nofollow" class="cursor-pointer box-border font-semibold border-b hover:border-b-[2px] transition-all duration-75 " style="text-decoration: none; color: inherit; border-color: var(--portal-accent-color);">​</a>Inputs</h2>A breakdown of all required and optional inputs for the GitHub action.<table class="" style="min-width: 75px"><colgroup><col style="min-width: 25px"><col style="min-width: 25px"><col style="min-width: 25px"></colgroup><tbody><tr><th colspan="1" rowspan="1">Input Name</th><th colspan="1" rowspan="1">Required?</th><th colspan="1" rowspan="1">Description</th></tr><tr><td colspan="1" rowspan="1">api_key</td><td colspan="1" rowspan="1">Yes</td><td colspan="1" rowspan="1">Application specific API Key, should be stored and pass in as a secret</td></tr><tr><td colspan="1" rowspan="1">structure</td><td colspan="1" rowspan="1">Yes</td><td colspan="1" rowspan="1">Structure type. Either <code class="bg-gray-200 dark:bg-gray-800 text-gray-600 dark:text-gray-300 font-mono text-sm px-1.5 py-0.5 rounded [&amp;::before]:content-none [&amp;::after]:content-none">file</code> (for single file build) or <code class="bg-gray-200 dark:bg-gray-800 text-gray-600 dark:text-gray-300 font-mono text-sm px-1.5 py-0.5 rounded [&amp;::before]:content-none [&amp;::after]:content-none">file+expansion</code> (for a primary build file with a single expansion file, i.e. apk + obb)</td></tr><tr><td colspan="1" rowspan="1">primary_file_path</td><td colspan="1" rowspan="1">Yes</td><td colspan="1" rowspan="1">Path to the primary file to upload</td></tr><tr><td colspan="1" rowspan="1">expansion_file_path</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Path to an expansion file to be paired with primary (optional)</td></tr><tr><td colspan="1" rowspan="1">version_component_1_major</td><td colspan="1" rowspan="1">Yes</td><td colspan="1" rowspan="1">Major version component</td></tr><tr><td colspan="1" rowspan="1">version_component_2_minor</td><td colspan="1" rowspan="1">Yes</td><td colspan="1" rowspan="1">Minor version component</td></tr><tr><td colspan="1" rowspan="1">version_component_3_patch</td><td colspan="1" rowspan="1">Yes</td><td colspan="1" rowspan="1">Patch version component</td></tr><tr><td colspan="1" rowspan="1">version_component_extra</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Extra version component (optional). Pre-release label like ‘beta’ or ‘alpha’</td></tr><tr><td colspan="1" rowspan="1">version_component_meta</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Meta version component (optional). Can be used to add additional metadata to your version, such as data <code class="bg-gray-200 dark:bg-gray-800 text-gray-600 dark:text-gray-300 font-mono text-sm px-1.5 py-0.5 rounded [&amp;::before]:content-none [&amp;::after]:content-none">2025.01.01</code>)</td></tr><tr><td colspan="1" rowspan="1">custom_build_number</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Allows a flexible format custom build number if you have one. (Optional)</td></tr><tr><td colspan="1" rowspan="1">ci_pipeline</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">CI pipeline name</td></tr><tr><td colspan="1" rowspan="1">ci_run_id</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">CI run ID</td></tr><tr><td colspan="1" rowspan="1">ci_run_url</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">CI run URL</td></tr><tr><td colspan="1" rowspan="1">ci_build_duration</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">CI build duration</td></tr><tr><td colspan="1" rowspan="1">vc_host_type</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Version control host type</td></tr><tr><td colspan="1" rowspan="1">vc_host</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Version control host</td></tr><tr><td colspan="1" rowspan="1">vc_repo_name</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Repository name</td></tr><tr><td colspan="1" rowspan="1">vc_repo_url</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Repository URL</td></tr><tr><td colspan="1" rowspan="1">vc_branch</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Branch name</td></tr><tr><td colspan="1" rowspan="1">vc_commit_sha</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Commit SHA</td></tr><tr><td colspan="1" rowspan="1">vc_commit_url</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Commit URL</td></tr><tr><td colspan="1" rowspan="1">platform</td><td colspan="1" rowspan="1">Yes</td><td colspan="1" rowspan="1">Platform slug (<a href="https://docs.buildstash.com/integrations/platforms" target="_blank" rel="noreferrer" class="cursor-pointer box-border font-semibold border-b hover:border-b-[2px] transition-all duration-75 " style="text-decoration: none; color: inherit; border-color: var(--portal-accent-color);">see list here for reference</a>)</td></tr><tr><td colspan="1" rowspan="1">stream</td><td colspan="1" rowspan="1">Yes</td><td colspan="1" rowspan="1">Stream - the exact name of the stream on your app this build will be sent to</td></tr><tr><td colspan="1" rowspan="1">notes</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Build notes (optional)</td></tr></tbody></table><h2>Outputs</h2>A breakdown of all required and optional inputs for the GitHub action.<table class="" style="min-width: 50px"><colgroup><col style="min-width: 25px"><col style="min-width: 25px"></colgroup><tbody><tr><th colspan="1" rowspan="1">Output Name</th><th colspan="1" rowspan="1">Description</th></tr><tr><td colspan="1" rowspan="1">build_id</td><td colspan="1" rowspan="1">Buildstash ID associated with the newly created build</td></tr><tr><td colspan="1" rowspan="1">pending_processing</td><td colspan="1" rowspan="1">Whether the build is pending additional processing on server (typically iOS or Android builds)</td></tr><tr><td colspan="1" rowspan="1">build_info_url</td><td colspan="1" rowspan="1">URL to view the build information on Buildstash</td></tr><tr><td colspan="1" rowspan="1">download_url</td><td colspan="1" rowspan="1">URL to download the build on Buildstash (requires authentication in workspace and permission to access build)</td></tr></tbody></table>Links<a href="https://github.com/marketplace/actions/buildstash" target="_blank" rel="noreferrer" class="cursor-pointer box-border font-semibold border-b hover:border-b-[2px] transition-all duration-75 " style="text-decoration: none; color: inherit; border-color: var(--portal-accent-color);">Buildstash on GitHub Marketplace</a>

Send build artifacts from your GitHub Actions workflows into Buildstash

GitHub Actions

Table of Contents