App Deploy Script

Deploy script used for creating tags with a tag message in the format internal-all/v1.0.0-1234, where internal-all is marking the workflow that should be started on the CI, v1.2.3 represents app version and 1234 represents the build number. Tag message set from this script can be used later for the changelog message on any CI (e.g. Bitrise). The build number is number calculated as the total number of tags available on GitHub incremented by one.

Installation

In order to install this script, just run this command in Terminal from your project root folder:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/infinum/app-deploy-script/master/install.sh)"

This script will install app-deploy into the /usr/local/bin/ and .deploy-options.sh into the root folder of the project.

Note: Do not change the name of the .deploy-options.sh file!

Script modifications

Main options

In general, the script should be used as-is.

The only part that should be changed is stored inside .deploy-options.sh file under the deploy_options function. This part of the script is responsible for creating the first part of the tag that can trigger a specific workflow on CI. If the given values are not enough or they are not representing the project structure, they can be replaced with different values.

Keep in mind that the prefix internal- should be used for the builds created for the internal testing, while builds for beta testing (i.e. Google Play Beta or Apple TestFlight) or public release, should be prefixed as beta- or playstore/ appstore.

Final variable name inside deploy_options function must stay: target

Configuration flags

As tag creation is separated into a few small steps, some of them can be skipped and/or disabled by changing configuration flags at the beginning of the script inside .deploy-options.sh file.

# If enabled, console will be cleared on every script run.
# By default, this option is enabled
use_automatic_console_clean=true
# If enabled, not pushed commits will be pushed automatically without confirmation dialog.
# By default, this option is disabled
enable_automatic_commit_push=false
# If enabled, confirmation dialog with deploy summary will be presented.
# By default, this option is enabled
enable_final_confirmation=true

Usage

Script should be run just by calling the script name from the folder where .deploy-options.sh is stored (e.g. root folder):

app-deploy

After that, the script will check if everything is pushed to the remote, and if needed it will push all commits before it continues (automatic push can be enabled with enable_automatic_commit_push flag).

###############################################################
#                         DEPLOY SCRIPT                       #
#                                                             #
#                   Copyright (c) 2020 Infinum.               #
###############################################################


###############################################################
#                      COMMIT CHECK                           #
###############################################################

---------------------------------------------------------------
Targeting commit: e3e45889b
---------------------------------------------------------------
#123: Add my cool feature
---------------------------------------------------------------

The next step is selecting one or multiple targets that should be run on CI. Enter one or more numbers separated by whitespaces:

###############################################################
#                  DEPLOY TARGET SELECTION                    #
###############################################################

--------------
| TryOutApps |
--------------

[0] All
[1] Test
[2] Develop
[3] Simulation
[4] Production

==================

---------------------
| APP STORE CONNECT |
---------------------

[5] App Store

Enter number in square brackets:

After selecting the target, the script will check the app version from the latest tag found on the current branch. The new version can be always set by typing it in the console. If the preselected version is the correct one, just hit enter and the script will continue with getting and calculating the next build number.

###############################################################
#                         APP VERSION                         #
###############################################################

Press enter to use last known version: 2.4.0. (or enter different version)
Getting next build number...

Next app version is: v2.4.0-6029

The last step is to add the changelog. When creating the tag, the console will open a preselected text editor where a changelog can be added. Keep in mind that closing that editor without entering the changelog will result in a script termination.

###############################################################
#                          CHANGELOG                          #
###############################################################

------------------------------------------------------------
Enter changelog message...
------------------------------------------------------------

If everything is done correctly, the confirmation step will be shown with the summary of selected options (can be skipped by disabling the enable_final_confirmation flag):

###############################################################
#                          DEPLOY                             #
###############################################################

---------------------------------------------------------------
                      ~ CONFIGURATION ~

Target: 1. internal-test
Version: v2.4.0-6029
Tag: internal-test/v2.4.0-6029

Changelog:
New features:

* first
* second
---------------------------------------------------------------

Is configuration correct for the CI deployment? [y/n]

In the end, the tag is created and pushed to the remote.

Updating

The script has the ability to auto-update itself. To update the script, just add --update argument.

app-deploy --update

The script will fetch the latest available changes from the repo and it will change the content of the app-deploy.sh script with the fetched one. Keep in mind that this will result in overwrite of any changes made by you inside app-deploy.sh file. This update will not effect .deploy-options.sh file.

Contributing

Feedback and code contributions are very much welcome. Just make a pull request with a short description of your changes. By making contributions to this project you permit your code to be used under the same license.

Credits

Maintained and sponsored by Infinum.