A Continuous Integration Generator
Project description
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
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
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
github-actions Python example:
cigen github-actions python -n myproject -b push main -a 1 -v 3.9.6
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
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file ci-generator-0.2.0.tar.gz
.
File metadata
- Download URL: ci-generator-0.2.0.tar.gz
- Upload date:
- Size: 13.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f53be76f7ff837c5677dd19a4e0a9b812dbb5099b2abd8975bb9d70417f89643 |
|
MD5 | 1efb9466670284762f9a7e6aebb74cc5 |
|
BLAKE2b-256 | e9e3c10c148f29ba265e55050dd44c0288b303cea3c9ff3eb49178ebee1bbae2 |
File details
Details for the file ci_generator-0.2.0-py3-none-any.whl
.
File metadata
- Download URL: ci_generator-0.2.0-py3-none-any.whl
- Upload date:
- Size: 21.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 749fcc848b55b9816b9056453dfc2b495255dbcb5f4b98479a28d59cf81e645f |
|
MD5 | 439f871e2f534c1a456eb81e8cb7b322 |
|
BLAKE2b-256 | a1a180f38e78906e1d673aa08d75cf0eb5a5ee83889eeb61beb7b9694f88f1ab |