You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-15
Original file line number
Diff line number
Diff line change
@@ -1,30 +1,30 @@
1
1
# App Deploy Script
2
2
3
-
Deploy script used for creating the tag with tag message in 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 a total number of tags available on GitHub incremented by one.
3
+
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.
4
4
5
5
## Installation
6
6
7
-
In order to install this script, just run this command in terminal from your <u>project root folder</u>:
7
+
In order to install this script, just run this command in Terminal from your <u>project root folder</u>:
This script will install `app-deploy` into the `/usr/local/bin/` and `.deploy-options.sh` into the root folder of the project.
13
-
> Note: Do not change name of the `.deploy-options.sh` file!
13
+
> Note: Do not change the name of the `.deploy-options.sh` file!
14
14
15
15
## Script modifications
16
16
17
17
### Main options
18
18
In general, the script should be used as-is.
19
19
20
-
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 given values are not enough or they are not representing the project structure, they can be replaced with different values.
20
+
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.
21
21
22
-
> Keep in mind that 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`.
22
+
> 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`.
23
23
24
24
**Final variable name inside `deploy_options` function must stay: `target`**
25
25
26
26
### Configuration flags
27
-
As tag creation is separated into the 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.
27
+
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.
28
28
29
29
```bash
30
30
# If enabled, console will be cleared on every script run.
@@ -46,7 +46,7 @@ Script should be run just by calling the script name from the folder where `.dep
46
46
app-deploy
47
47
```
48
48
49
-
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).
49
+
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).
Next step is selecting one or multiple targets that should be run on CI. Enter one or more numbers separated by whitespaces:
70
+
The next step is selecting one or multiple targets that should be run on CI. Enter one or more numbers separated by whitespaces:
71
71
72
72
```bash
73
73
@@ -109,7 +109,7 @@ Getting next build number...
109
109
Next app version is: v2.4.0-6029
110
110
```
111
111
112
-
The last step is to add the changelog. When creating the tag, the console will open a preselected text editor where changelog can be added. Keep in mind that closing that editor without entered changelog will result in the script termination.
112
+
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.
@@ -149,20 +149,27 @@ In the end, the tag is created and pushed to the remote.
149
149
150
150
## Updating
151
151
152
-
Script have the ability to auto-update itself. To update the script, just add `--update` argument.
152
+
The script has the ability to auto-update itself. To update the script, just add `--update` argument.
153
153
```bash
154
154
app-deploy --update
155
155
```
156
156
157
-
Script will fetch latest available changes from the repo and it will change the content of the `app-deploy.sh` script with 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.***
157
+
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.***
158
158
159
159
## Contributing
160
160
161
161
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](https://github.com/infinum/app-deploy-script/blob/master/LICENSE).
162
162
163
163
## Credits
164
164
165
-
Maintained and sponsored by [Infinum](http://www.infinum.com).
0 commit comments