Push local changes to the remote branch

Lets you push your local commits to a remote git repo. Useful if you make local changes such as adding a version bump commit (using commit_version_bump) or a git tag (using 'add_git_tag') on a CI server, and you want to push those changes back to your canonical/main repo.
If this is a new branch, use the set_upstream option to set the remote branch as upstream.

Supported platforms ios, android, mac
Author @lmirosevic

2 Examples

push_to_git_remote # simple version. pushes "master" branch to "origin" remote
  remote: "origin",         # optional, default: "origin"
  local_branch: "develop",  # optional, aliased by "branch", default is set to current branch
  remote_branch: "develop", # optional, default is set to local_branch
  force: true,    # optional, default: false
  force_with_lease: true,   # optional, default: false
  tags: false,    # optional, default: true
  no_verify: true,# optional, default: false
  set_upstream: true        # optional, default: false


Key Description Default
local_branch The local branch to push from. Defaults to the current branch *
remote_branch The remote branch to push to. Defaults to the local branch *
force Force push to remote false
force_with_lease Force push with lease to remote false
tags Whether tags are pushed to remote true
remote The remote to push to origin
no_verify Whether or not to use --no-verify false
set_upstream Whether or not to use --set-upstream false
push_options Array of strings to be passed using the '--push-option' option []

* = default value is dependent on the user's system


To show the documentation in your terminal, run

fastlane action push_to_git_remote


It is recommended to add the above action into your Fastfile, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal

fastlane run push_to_git_remote

To pass parameters, make use of the : symbol, for example

fastlane run push_to_git_remote parameter1:"value1" parameter2:"value2"

It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. param:"1,2,3"). Hashes are not currently supported.

It is recommended to add all fastlane actions you use to your Fastfile.

Source code

This action, just like the rest of fastlane, is fully open source, view the source code on GitHub

Back to actions