Skip to content

Latest commit

 

History

History
217 lines (147 loc) · 3.92 KB

README.md

File metadata and controls

217 lines (147 loc) · 3.92 KB
Raw

ci generator

CI generator is a tool to generate CI configuration files for your project. It's a command line tool that can be used to generate CI configuration files for your project. It's written in Python and uses templates to generate the files.

Possible CI systems are:

  • GitHub Actions
  • Jenkins
  • Docker
  • Gitlab CI

They can integrate with the following tools:

  • SonarQube
  • SonarCloud
  • Test coverage
  • DockerFile
  • DockerCompose

Index

Installation

Multiplatform Linux, Windows, MacOs

pip install ci-generator

Usage

cigen --help

Github Actions

cigen github-actions --help

output:

Usage: cigen [OPTIONS] COMMAND [ARGS]...

  ciGen is a Continuous Integration Generator

Options:
  --help  Show this message and exit.

Commands:
  docker         This is the main command for the Docker
  github-action  This is the main command for the GitHub Actions
  gitlab         This is the main command for the GitLab
  jenkins        This is the main command for the Jenkins

[EXEMPLES OF USAGE] <- click here

github-actions subcommand can be used to generate Build and Test Github Actions configuration files.

Github Actions commands available

Go

github-actions Golang example:

cigen github-actions go -n myproject -b push main -a 1 -v 1.21.1

[EXEMPLES OF USAGE GOLANG] <- click here

NodeJS

github-actions NodeJS example:

cigen github-actions nodejs -n myproject -b push main -a 1 -v 14.17.3

[EXEMPLES OF USAGE NODEJS] <- click here

Commands not yet available

Jenkins

cigen jenkins --help

jenkins subcommand can be used to generate Build and Test Jenkins configuration files.

jenkins Golang example:

cigen jenkins go -n myproject -b push main -a 1 -v 1.21.1

jenkins Python example:

cigen jenkins python -n myproject -b push main -a 1 -v 3.9.6

Docker

cigen docker --help

docker subcommand can be used to generate Docker configuration files.

docker example:

cigen docker -n dockerfile -i golang -v 1.21.1 -s multi

Gitlab CI

cigen gitlab-ci --help

gitlab-ci subcommand can be used to generate Build and Test Gitlab CI configuration files.

gitlab-ci Golang example:

cigen gitlab-ci go -n myproject -b push main -a 1 -v 1.21.1

gitlab-ci Python example:

cigen gitlab-ci python -n myproject -b push main -a 1 -v 3.9.6

Installation - Development

Docker [dev]

docker build -t ci-generator .
docker run -it --rm ci-generator cigen --help

Docker Composer [dev]

docker-compose up -d
docker-compose run --rm ci-generator cigen --help

Python [dev]

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
pip install -e .
cigen --help

NOTE: ci generator is not yet fully stable, so it's not recommended to use it in production. It's still in development.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT