Skip to content

Commit 81c72d4

Browse files
Update README.md
1 parent 7e3a79a commit 81c72d4

File tree

1 file changed

+22
-15
lines changed

1 file changed

+22
-15
lines changed

README.md

+22-15
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
# App Deploy Script
22

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.
44

55
## Installation
66

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>:
88
```bash
99
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/infinum/app-deploy-script/master/install.sh)"
1010
```
1111

1212
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!
1414
1515
## Script modifications
1616

1717
### Main options
1818
In general, the script should be used as-is.
1919

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.
2121

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`.
2323
2424
**Final variable name inside `deploy_options` function must stay: `target`**
2525

2626
### 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.
2828

2929
```bash
3030
# 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
4646
app-deploy
4747
```
4848

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).
5050

5151
```bash
5252
###############################################################
@@ -67,7 +67,7 @@ Targeting commit: e3e45889b
6767
---------------------------------------------------------------
6868
```
6969

70-
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:
7171

7272
```bash
7373

@@ -109,7 +109,7 @@ Getting next build number...
109109
Next app version is: v2.4.0-6029
110110
```
111111

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.
113113

114114
```bash
115115
###############################################################
@@ -149,20 +149,27 @@ In the end, the tag is created and pushed to the remote.
149149

150150
## Updating
151151

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.
153153
```bash
154154
app-deploy --update
155155
```
156156

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.***
158158

159159
## Contributing
160160

161161
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).
162162

163163
## Credits
164164

165-
Maintained and sponsored by [Infinum](http://www.infinum.com).
166-
<a href='https://infinum.com'>
167-
<img src='https://infinum.com/infinum.png' href='https://infinum.com' width='264'>
168-
</a>
165+
Maintained and sponsored by
166+
[Infinum](https://infinum.com).
167+
168+
<p align="center">
169+
<a href='https://infinum.com'>
170+
<picture>
171+
<source srcset="https://assets.infinum.com/brand/logo/static/white.svg" media="(prefers-color-scheme: dark)">
172+
<img src="https://assets.infinum.com/brand/logo/static/default.svg">
173+
</picture>
174+
</a>
175+
</p>

0 commit comments

Comments
 (0)