This shell script provides a robust starting point for creating new sh scripts. It is designed to be modular and easily extendable, making it ideal for a wide range of scripting tasks. This is particularly useful for CI tasks in a CI/CD environment. The goal is to have a single script that can be used for multiple tasks that is uniform and easy to maintain.
- Command line options parsing
- Config file support
- Prerequisite binary checks
- Verbose logging
- Signal handling
- Templated functions for common tasks
By default, you can run the script with the following command and the --config to a config file is COMPLETELY OPTIONAL:
./shell-skeleton.sh --foo [value] --config /path/to/configNOTE: You may need to chmod the script.
chmod +x shell-skeleton.shThere is a sample config.env file included to show the format of the file. Again this is completely optional and you can pass in the values via the command line.
-c,--config: Specify the path to the environment configuration file.-h,--help: Display the help message and exit.-f,--foo: An example flag to demonstrate usage.
To extend the script's functionality:
- Define new functions in the Functions section.
- If needed, add new command line options in the while options loop.
The script checks for required binaries before execution. To modify the prerequisites:
- Update the
REQUIRED_BINARIESat the top of the script with the names of the binaries your script requires.
The script can be run in a Docker container. To build the container:
docker build . -t shell-skeleton:latestTo run the container:
docker run -it -v /path/to/local/config:/path/in/container/config shell-skeleton:latest --config /path/in/container/config --foo your_value - The script is designed to be modular. Add new functions and features as needed.
- It's recommended to test new changes in a controlled environment before deployment.
Contributions to improve this script are welcome. Please adhere to best practices for shell scripting.