Skip to content

Tool Specific Config

Lucie Hutchins edited this page Mar 21, 2018 · 17 revisions

Each tool has a package config file that sets environment variables specific to the tool. Only few are required for each tool.

File name format: tool_package.cfg

 Example: bamtools_package.cfg 

Required

  • SHORT_NAME : The name of the tool - all in lowercase - This is used to create the tool base directories
  • REMOTE_URL: Url path to files on remote server
  • REPOS_TAG_PATTERN: Used by getToolVersion.sh script to detect the release version format
  • REMOTE_VERSION_FILE:Used by getToolVersion.sh script to fetch the tool's current version
  • RELEASE_DIR: The Pattern/Format of the local directory for each release

And

For Tools We Install From Binaries

Set 
- REMOTE_FILES  
- EXPORT_GIT=false 
- TEMP_DOWNLOAD_DIR

If We Get The version info from a file, also set 
- VERSION_PREFIX
- VERSION_SUFFIX
- EXP_PREFIX
- CLONE_GIT=false

OR
If We Get The version info from GitHub, also set 
- GIT_ORG
- GIT_REPOS
- CLONE_GIT=true

For Tools We Install From Source

If we export the repos from GitHub, then set
- GIT_ORG
- GIT_REPOS
- EXPORT_GIT=true

If we download from remote site, then set  
- REMOTE_FILES  
- EXPORT_GIT=false 
- TEMP_DOWNLOAD_DIR

If We Get The version info from a file, also set 
- VERSION_PREFIX
- VERSION_SUFFIX
- EXP_PREFIX
- CLONE_GIT=false

If We Get The version info from GitHub, also set 
- CLONE_GIT=true