/cinit

CICD Initializer called cinit this command line will help you to generate github action, gitlab ci, bitbucket pipeline and jenkinsfile

Primary LanguageRust

cinit

cinit is a command-line tool written in Rust that initializes CI/CD configuration files for GitLab CI, GitHub Actions, Bitbucket Pipelines, and Jenkins. It helps developers quickly set up continuous integration and deployment pipelines for their projects.

Features

  • Initialize GitLab CI configuration file.
  • Initialize GitHub Actions configuration file.
  • Initialize Bitbucket Pipelines configuration file.
  • Initialize Jenkins configuration file.

Requirements

  • Rust (latest stable version)
  • Docker (optional, for building and running the project in a container)

Installation

From Source

  1. Clone the repository:

    git clone https://github.com/yourusername/cinit.git
    cd cinit
  2. Build the project:

    cargo build --release
  3. Install the binary:

    sudo cp target/release/cinit /usr/local/bin/

Using Docker

  1. Build the Docker image:

    docker build -t cinit .
  2. Run the Docker container to check the version:

    docker run --rm cinit

Usage

After installation, you can use the cinit command to initialize CI/CD configuration files.

Commands

  1. Initialize GitLab CI configuration:

    cinit gitlabci
  2. Initialize GitHub Actions configuration:

    cinit github
  3. Initialize Bitbucket Pipelines configuration:

    cinit bitbucket
  4. Initialize Jenkins configuration:

    cinit jenkins

Help

For help with commands, you can use the --help flag:

cinit --help

Development

Testing

To run the tests, use:

cargo test

Makefile

A Makefile is provided to simplify common tasks.

  • Build the project:

    make build
  • Install the binary:

    make install
  • Uninstall the binary:

    make uninstall
  • Clean the project:

    make clean
  • Run tests:

    make test

Dockerfile

A Dockerfile is provided to build and run the project in a Docker container:

Build the Docker image

docker build -t cinit .

Run the Docker container to check the version

docker run --rm cinit

Contributing

Contributions are welcome! Please fork the repository and submit a pull request for any improvements or bug fixes.

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes and commit them (git commit -am 'Add new feature').
  4. Push to the branch (git push origin feature-branch).
  5. Open a pull request.

Acknowledgments

  • Clap - A simple to use, full-featured Command Line Argument Parser for Rust.
  • Rust - A language empowering everyone to build reliable and efficient software.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

If you have any questions or suggestions, feel free to reach out at kukuhsatriowibowo@gmail.com.

Happy Coding!