Skip to content

Commit

Permalink
Script docu comments update
Browse files Browse the repository at this point in the history
  • Loading branch information
stankolubomir committed Nov 7, 2023
1 parent a14979a commit 29f887b
Show file tree
Hide file tree
Showing 8 changed files with 22 additions and 21 deletions.
6 changes: 3 additions & 3 deletions bin/bash
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/bash
# Script used to run bash in the application docker container
# Script used to run bash in the application container

PROJECT_ROOT="$( cd "$( dirname "${BASH_SOURCE[0]}" )"/.. && pwd )"
USER_SWITCH="--user node"
Expand All @@ -15,10 +15,10 @@ docker_env_vars

function help() {
echo -en "$(printf %q "${BASH_SOURCE[0]}") [OPERATION] [OPTIONS]...
\nScript used to run bash in the application docker container
\nScript used to run bash in the application container
Options:
--root (Optional) Run bash as root in the docker container
--root (Optional) Run bash as root in the application container
Examples:
$(printf %q "${BASH_SOURCE[0]}") --root
Expand Down
2 changes: 1 addition & 1 deletion bin/build
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/bash
# Script used to run build in the application docker container
# Script used to run build in the application container

PROJECT_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")"/.. && pwd)"
cd "${PROJECT_ROOT}" || exit 1
Expand Down
4 changes: 2 additions & 2 deletions bin/dev
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/bash
# Script used to run node dev server in the application docker container
# Script used to run node dev server in the application container

PROJECT_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")"/.. && pwd)"
ARGS="$*"
Expand All @@ -17,7 +17,7 @@ docker_env_vars

function help() {
echo -en "$(printf %q "${BASH_SOURCE[0]}") [OPERATION] [OPTIONS]...
\nScript used to run node dev server in the application docker container.
\nScript used to run node dev server in the application container.
Options:
-ni | --no-install (Optional) Run dev server without 'yarn install'
Expand Down
2 changes: 1 addition & 1 deletion bin/lint
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/bash
# Script used to run the linter check inside the application docker container
# Script used to run the linter check in the application container

PROJECT_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")"/.. && pwd)"
cd "${PROJECT_ROOT}" || exit 1
Expand Down
2 changes: 1 addition & 1 deletion bin/security
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/bash
# Script used to run the security check inside the application docker container
# Script used to run the security check in the application container

PROJECT_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")"/.. && pwd)"
cd "$PROJECT_ROOT" || exit 1
Expand Down
23 changes: 12 additions & 11 deletions bin/test
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/bash
#Script used to run the tests inside the application docker container
# Script used to run the tests in the application container
#######################################################################################################################
# Default variables
#######################################################################################################################
Expand All @@ -23,18 +23,19 @@ cd "${PROJECT_ROOT}" || exit 1
docker_env_vars

function help() {
echo "
$(printf %q "${BASH_SOURCE[0]}") [OPERATION] [OPTIONS]...
echo -en "$(printf %q "${BASH_SOURCE[0]}") [OPERATION] [OPTIONS]...
\nBash script used to run the tests in the application container
Options:
-e --env [(Optional) Environment of the project (Allowed values: local | dev | stg, Default: local)]
-b --browser [(Optional) Browser for test execution (Allowed values: chrome | electron | firefox, Default: chrome)]
-f --filter [(Optional) Comma separated list of filters (Default: n/a - all tests)]
-t --tag [(Optional) Only for dashboard runs tags for cypress dashboard list]
-d [(Optional) Cypress dashboard run, results will be stored in dashboard as well as in 'cypress/report' folder]
-e --env (Optional) Environment of the project (Allowed values: local | dev | stg, Default: local)
-b --browser (Optional) Browser for test execution (Allowed values: chrome | electron | firefox, Default: chrome)
-f --filter (Optional) Comma separated list of filters (Default: n/a - all tests)
-t --tag (Optional) Only for dashboard runs tags for cypress dashboard list
-d (Optional) Cypress dashboard run, results will be stored in dashboard as well as in 'cypress/report' folder
Example:
$(printf %q "${BASH_SOURCE[0]}") -e local -b chrome -t @ --tag Docker,Web -d
"
Examples:
$(printf %q "${BASH_SOURCE[0]}") -e local -b chrome -t @datepicker,@nl --tag Docker,Web -d
\n"
}

#######################################################################################################################
Expand Down
2 changes: 1 addition & 1 deletion docker/app/local/usr/local/bin/env-config
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/bash
# Script to run the setup of config.json file using .env files and exported variables:
# Script used to run the setup of config.json file using .env files and exported variables:
# - if the variable is exported in system, then it is left untouched and not exported from any env file
# - all missing variables are exported from main env file if exists
# - all missing variables (the same as from main env file) are exported from local env file if exists
Expand Down
2 changes: 1 addition & 1 deletion docker/app/local/usr/local/bin/start-command
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/bash
# Script to run setup inside the container
# Script used to run start setup inside the container
set -e

cd /var/www/html || exit 1
Expand Down

0 comments on commit 29f887b

Please sign in to comment.