Bash Project Template

A template repository for Bash projects, including CI/CD setup, testing, and code coverage integration.

Table of Contents

• About
• Status
• Usage
• Installation
• Development and Testing
• Contributing
• License

About

This repository serves as a template for new Bash projects, providing a starting point with essential configurations for continuous integration, testing, and code coverage.

Status

Master Branch

Stable Branch

Usage

To use this template as the basis for your new project, clone your new repository and start development.

Cloning the Repository

# Navigate to your development directory
cd /path/to/your/dev/directory

# Clone your new repository
git clone https://github.com/reactive-firewall/MY-NEW-REPO.git MY-NEW-REPO

# Change into the project directory
cd MY-NEW-REPO

Example Script

An example script speed_test.bash is included in the bin directory.

Running the Script

bin/speed_test.bash

Sample Output

Local:  4620K
Server: 1472K

Installation

To install the example script and other project components:

Download the Repository

cd /tmp
git clone https://github.com/reactive-firewall/bash-repo.git bash-repo
cd bash-repo
make clean

Install

You may need superuser permissions for installation.

sudo make install

Uninstall

To uninstall:

sudo make uninstall

Development and Testing

For development and running tests, use the provided Makefile.

Running Tests

make clean    # Cleans up from any previous tests
make test     # Runs the tests
make clean    # Cleans up after tests

Contributing

Contributions are welcome! Please adhere to the project's coding standards:

• CEP-5: Custom coding standard for Bash scripts.
• CEP-8: Custom coding standard for Python scripts.

Ensure that all scripts use POSIX built-ins (e.g., use printf instead of echo) and follow the project's style guidelines, such as keeping the shebang line with an extra space (e.g., #! /bin/bash).

License