ci-generate

This tool generates either new projects for some build systems or configuration files for some Continuous Integration with the use of templates.

Templates define the layout for a project and allow developers to insert data at runtime.

Each template contains all files necessary to build a project with a build system, in addition to Continuous Integration and Docker files used to run tests and implement further checks.

Supported build systems

✅: Not necessary for the considered language

Commands

To see the list of supported commands, run: ci-generate --help

Each command has an optional argument to define a license and an optional argument to override the project name instead of using the last component of the project-path. The default value for the license argument is MIT.

cargo

$ ci-generate cargo [--license LICENSE --name NAME --branch GITHUB_BRANCH] project-path

maven

$ ci-generate maven [--license LICENSE --name NAME --branch GITHUB_BRANCH] project-group project-path

meson

$ ci-generate meson [--kind meson-project-kind] [--license LICENSE --name NAME --branch GITHUB_BRANCH] project-path

Admitted values for the kind argument:

• c
• c++

poetry

$ ci-generate poetry [--license LICENSE --name NAME --branch GITHUB_BRANCH] project-path

yarn

$ ci-generate yarn [--license LICENSE --name NAME --branch GITHUB_BRANCH] project-path

Configuration

It is possible to save a config.toml in ${XDG_CONFIG_HOME}/ci-generate (Usually ~/.config/ci-generate) with overrides for all the default and optional values, e.g:

[default]
license = "BSD-3-Clause"

[meson]
kind = "c++"

Will override the default license and meson.kind configuration items and it would be equivalent to call:

$ ci-generate meson -k c++ -l BSD-3-Clause

The cli arguments take priority over the built-in defaults and the config.toml overrides so

$ ci-generate meson -l LGPL-2.1

Would take the kind = c++ from the config.toml and LGPL-2.1 from the command line.

License

Released under the MIT License.