CI/CD Generators on DevOps-OS

GitHub Actions

Mon, 01 Jan 0001 00:00:00 +0000

GitHub Actions Workflow Generator#

The GitHub Actions generator creates YAML workflow files that orchestrate CI/CD processes using GitHub’s built-in action system. Workflows leverage the DevOps-OS container for a consistent build environment.

Basic Usage#

python -m cli.devopsos scaffold gha --name "my-app" --type complete

Output: .github/workflows/my-app-complete.yml

The filename pattern is <name-hyphenated>-<type>.yml inside the output directory.
Change the output directory with --output <dir> (default: .github/workflows/).

Options#

Option	Default	Description
`--name NAME`	`DevOps-OS`	Workflow name
`--type TYPE`	`complete`	`build` \| `test` \| `deploy` \| `complete` \| `reusable`
`--languages LANGS`	`python,javascript`	Comma-separated: `python`, `java`, `javascript`, `go`
`--kubernetes`	off	Include Kubernetes deployment steps
`--registry URL`	`ghcr.io`	Container registry URL
`--k8s-method METHOD`	`kubectl`	`kubectl` \| `kustomize` \| `argocd` \| `flux`
`--output DIR`	`.github/workflows`	Output directory
`--custom-values FILE`	(none)	Path to custom values JSON file
`--image IMAGE`	`ghcr.io/yourorg/devops-os:latest`	DevOps-OS container image
`--branches BRANCHES`	`main`	Comma-separated branches that trigger the workflow
`--matrix`	off	Enable matrix builds across OS/architectures
`--env-file FILE`	(cli dir)	Path to `devcontainer.env.json`
`--reusable`	off	Generate a reusable workflow

Workflow Types#

Type	Description
`build`	Focuses on building and packaging your application
`test`	Focuses on running tests
`deploy`	Focuses on deploying to the target environment
`complete`	Combines build, test, and deploy stages
`reusable`	Creates a workflow callable from other workflows

Examples#

Python application — complete pipeline#

python -m cli.devopsos scaffold gha --name "Python App" --languages python --type complete
# Output: .github/workflows/python-app-complete.yml

Java with Maven#

python -m cli.devopsos scaffold gha --name "Java Service" --languages java --custom-values maven-config.json
# Output: .github/workflows/java-service-complete.yml

Multi-language microservices with Kubernetes#

python -m cli.devopsos scaffold gha \
 --name "Microservices" \
 --languages python,javascript,go \
 --kubernetes --k8s-method kustomize
# Output: .github/workflows/microservices-complete.yml

Matrix build (cross-platform)#

python -m cli.devopsos scaffold gha --name "Node.js App" --languages javascript --matrix
# Output: .github/workflows/node-js-app-complete.yml

Reusable workflow#

python -m cli.devopsos scaffold gha --name "shared" --type reusable
# Output: .github/workflows/shared-reusable.yml

Environment Variables#

All options can be set using environment variables prefixed with DEVOPS_OS_GHA_:

GitLab CI

Mon, 01 Jan 0001 00:00:00 +0000

GitLab CI Pipeline Generator#

Generate a complete .gitlab-ci.yml for your project in a single command. The generator creates multi-stage pipelines with language-specific test jobs, Docker build, and Kubernetes deployment.

Basic Usage#

python -m cli.devopsos scaffold gitlab --name my-app --languages python --type complete

Output: .gitlab-ci.yml (default)
Change the output path with --output <path>.

Options#

Option	Default	Description
`--name NAME`	`my-app`	Application / pipeline name
`--type TYPE`	`complete`	`build` \| `test` \| `deploy` \| `complete`
`--languages LANGS`	`python`	Comma-separated: `python`, `java`, `javascript`, `go`
`--kubernetes`	off	Add a Kubernetes deploy stage
`--k8s-method METHOD`	`kubectl`	`kubectl` \| `kustomize` \| `argocd` \| `flux`
`--output FILE`	`.gitlab-ci.yml`	Output file path
`--image IMAGE`	`docker:24`	Default Docker image for pipeline jobs
`--branches BRANCHES`	`main`	Branches that trigger deploy jobs
`--kube-namespace NS`	(empty)	Kubernetes namespace (empty = use `$KUBE_NAMESPACE` variable)
`--custom-values FILE`	(none)	Path to custom values JSON file

All options can be set via environment variables prefixed DEVOPS_OS_GITLAB_.

Jenkins

Mon, 01 Jan 0001 00:00:00 +0000

Jenkins Pipeline Generator#

Generate Jenkinsfile scripts using the declarative pipeline syntax. Pipelines leverage the DevOps-OS container for a consistent build environment.

Basic Usage#

python -m cli.devopsos scaffold jenkins --name "my-app" --type complete

Output: Jenkinsfile (default)
Change the output path with --output <path>.

Options#

Option	Default	Description
`--name NAME`	`DevOps-OS`	Pipeline name
`--type TYPE`	`complete`	`build` \| `test` \| `deploy` \| `complete` \| `parameterized`
`--languages LANGS`	`python,javascript`	Comma-separated: `python`, `java`, `javascript`, `go`
`--kubernetes`	off	Add Kubernetes deploy stage
`--registry URL`	`docker.io`	Container registry URL
`--k8s-method METHOD`	`kubectl`	`kubectl` \| `kustomize` \| `argocd` \| `flux`
`--output FILE`	`Jenkinsfile`	Output file path
`--custom-values FILE`	(none)	Path to custom values JSON file
`--image IMAGE`	`docker.io/yourorg/devops-os:latest`	DevOps-OS container image
`--scm SCM`	`git`	Source control: `git` \| `svn` \| `none`
`--parameters`	off	Add runtime parameters (auto-enabled for `--type parameterized`)
`--env-file FILE`	(cli dir)	Path to `devcontainer.env.json`

All options can be set via environment variables prefixed DEVOPS_OS_JENKINS_.