mirror of
https://github.com/cisagov/log4j-affected-db.git
synced 2024-11-22 16:40:48 +00:00
Improve usage message.
This commit is contained in:
parent
8a105ca040
commit
ae21af1084
1 changed files with 11 additions and 3 deletions
14
setup-env
14
setup-env
|
@ -5,17 +5,25 @@ set -o errexit
|
||||||
set -o pipefail
|
set -o pipefail
|
||||||
|
|
||||||
USAGE=$(cat << 'END_OF_LINE'
|
USAGE=$(cat << 'END_OF_LINE'
|
||||||
This script is used to configure a developement environment for this repo.
|
Configure a developement environment for this repository.
|
||||||
|
|
||||||
It does the following:
|
It does the following:
|
||||||
- Verifies pyenv and pyenv-virtualenv are installed.
|
- Verifies pyenv and pyenv-virtualenv are installed.
|
||||||
- Creates a Python virtual environment.
|
- Creates a Python virtual environment.
|
||||||
- Configures the activation of the virtual enviroment for the repo directory.
|
- Configures the activation of the virtual enviroment for the repo directory.
|
||||||
- Installs the requirements required for development.
|
- Installs the requirements needed for development.
|
||||||
- Installs git pre-commit hooks.
|
- Installs git pre-commit hooks.
|
||||||
- Configures git upstream remote "lineage" repositories.
|
- Configures git upstream remote "lineage" repositories.
|
||||||
|
|
||||||
usage: setup-env [--force] [--help] [virt_env_name]
|
Usage:
|
||||||
|
setup-env [--force] [virt_env_name]
|
||||||
|
setup-env (-h | --help)
|
||||||
|
|
||||||
|
Options:
|
||||||
|
-f --force Delete virtual enviroment if it already exists.
|
||||||
|
-h --help Show this message.
|
||||||
|
-i --install-hooks Install hook environments for all environments in the
|
||||||
|
pre-commit config file.
|
||||||
|
|
||||||
END_OF_LINE
|
END_OF_LINE
|
||||||
)
|
)
|
||||||
|
|
Loading…
Reference in a new issue