Skip to content
This repository has been archived by the owner on Jun 25, 2024. It is now read-only.

Bitrise step to run a remote script hosted in GitHub. Similar to Remote Script Runner but can use private repos and pass command line arguments

License

Notifications You must be signed in to change notification settings

deliveroo/bitrise-step-github-script-runner

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Bash Script Runner

Downloads the content of a script hosted in GitHub and runs it as a bash script. It is very similar to Remote Bash Script Runner Step but it allows you to do a couple of things more:

  1. You can use it with private repos
  2. You can pass command line arguments

Note: after implementing it, I've found it already exists a GitHub Script Runner...but it doesn't allow to pass command line arguments, so this work is not completely wasted :_D

How to use this Step

Locally, from the CLI

Can be run directly with the bitrise CLI, just git clone this repository, cd into it's folder in your Terminal/Command Line and call bitrise run cli-test.

Add GITHUB_TOKENto your .bitrise.secrets.yml file!

Step by step:

  1. Open up your Terminal / Command Line
  2. git clone the repository
  3. cd into the directory of the step (the one you just git cloned)
  4. Create a .bitrise.secrets.yml file in the same directory of bitrise.yml (the .bitrise.secrets.yml is a git ignored file, you can store your secrets in it)
  5. Add your GitHub personal access token to .bitrise.secrets.yml (use GITHUB_TOKEN as the key)
  6. Run this step with the bitrise CLI: bitrise run cli-test

An example .bitrise.secrets.yml file:

envs:
- GITHUB_TOKEN: {your_personal_access_token}

From a Bitrise step, using bitrise.yml

If you want to use your step in your project's bitrise.yml, reference it in your bitrise.yml with the git::https://github.com/deliveroo/bitrise-step-github-script-runner.git step reference style:

- git::https://github.com/deliveroo/bitrise-step-github-script-runner.git:
   title: The title of your step
   description: A description of your step (optional)
   inputs:
   - repository: {owner/repo} (e.g. deliveroo/mobile-scripts)
   - script_path: {path_relative_to_repo_root} (e.g. promon/promon-upload-file.sh)
   - branch: {default=master}
   - command_line_arguments: {the same arguments you'd pass to a local script} (e.g. --local-file-path "$BITRISE_SOURCE_DIR/README.md" --remote-folder-path "deliveroo/Upload/rider")
   - tmp_folder: {where you want to put all temporary files created by the script or leave it empty if you want to use the default "$BITRISE_SOURCE_DIR/tmp"}
   - github_token: {your personal access token or leave it empty if you have a GITHUB_TOKEN secret configured}

That's all ;)

About

Bitrise step to run a remote script hosted in GitHub. Similar to Remote Script Runner but can use private repos and pass command line arguments

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages