部署与云服务
jenkinsfile-generator
Generate/create/scaffold Jenkinsfile — declarative, scripted, shared library, CI/CD pipelines.
akin-ozer · 已有 AI 审核记录
安装与使用
运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。
npx skills add akin-ozer/cc-devops-skills --skill jenkinsfile-generator技能说明
name: jenkinsfile-generator description: Generate/create/scaffold Jenkinsfile — declarative, scripted, shared library, CI/CD pipelines.
Jenkinsfile Generator Skill
Generate production-ready Jenkinsfiles following best practices. All generated files are validated using devops-skills:jenkinsfile-validator skill.
Trigger Phrases
- "Generate a CI pipeline for Maven/Gradle/npm"
- "Create a Jenkins deployment pipeline with approvals"
- "Build a Jenkinsfile with parallel test stages"
- "Create a scripted pipeline with dynamic stage logic"
- "Scaffold a Jenkins shared library"
- "Generate a Jenkinsfile for Docker or Kubernetes agents"
When to Use
- Creating new Jenkinsfiles (declarative or scripted)
- CI/CD pipelines, Docker/Kubernetes deployments
- Parallel execution, matrix builds, parameterized pipelines
- DevSecOps pipelines with security scanning
- Shared library scaffolding
Declarative vs Scripted Decision Tree
- Choose Declarative by default when stage order and behavior are mostly static.
- Choose Scripted when runtime-generated stages, complex loops, or dynamic control flow are required.
- Choose Shared Library scaffolding when request is about reusable pipeline functions (
vars/,src/,resources/). - If unsure, start Declarative and only switch to Scripted if requirements cannot be expressed cleanly.
Template Map
| Template | Path | Use When |
|---|---|---|
| Declarative basic | assets/templates/declarative/basic.Jenkinsfile | Standard CI/CD with predictable stages |
| Declarative parallel example | examples/declarative-parallel.Jenkinsfile | Parallel test/build branches with fail-fast behavior |
| Declarative kubernetes example | examples/declarative-kubernetes.Jenkinsfile | Kubernetes agent execution using pod templates |
| Scripted basic | assets/templates/scripted/basic.Jenkinsfile | Complex conditional logic or generated stages |
| Shared library scaffold | Generated by scripts/generate_shared_library.py | Reusable pipeline functions and organization-wide patterns |
Quick Reference
// Minimal Declarative Pipeline
pipeline {
agent any
stages {
stage('Build') { steps { sh 'make' } }
stage('Test') { steps { sh 'make test' } }
}
}
// Error-tolerant stage
stage('Flaky Tests') {
steps {
catchError(buildResult: 'SUCCESS', stageResult: 'UNSTABLE') {
sh 'run-flaky-tests.sh'
}
}
}
// Conditional deployment with approval
stage('Deploy') {
when { branch 'main'; beforeAgent true }
input { message 'Deploy to production?' }
steps { sh './deploy.sh' }
}
| Option | Purpose |
|---|---|
timeout(time: 1, unit: 'HOURS') | Prevent hung builds |
buildDiscarder(logRotator(numToKeepStr: '10')) | Manage disk space |
disableConcurrentBuilds() | Prevent race conditions |
catchError(buildResult: 'SUCCESS', stageResult: 'FAILURE') | Continue on error |
Core Capabilities
1. Declarative Pipelines (RECOMMENDED)
Process:
- Read templates for structure reference:
- Read
assets/templates/declarative/basic.Jenkinsfileto understand the standard structure - Templates show the expected sections: pipeline → agent → environment → options → parameters → stages → post
- For complex requests, adapt the structure rather than copying verbatim
- Read
- Consult reference documentation:
- Read
references/best_practices.mdfor performance, security, and reliability patterns - Read
references/common_plugins.mdfor plugin-specific syntax
- Read
- Generate with required elements:
- Proper stages with descriptive names
- Environment block with credentials binding (never hardcode secrets)
- Options: timeout, buildDiscarder, timestamps, disableConcurrentBuilds
- Post conditions: always (cleanup), success (artifacts), failure (notifications)
- Always add
failFast trueorparallelsAlwaysFailFast()for parallel blocks - Always include
fingerprint: truewhen usingarchiveArtifacts
- ALWAYS validate using devops-skills:jenkinsfile-validator skill
2. Scripted Pipelines
When: Complex conditional logic, dynamic generation, full Groovy control Process:
- Read templates for structure reference:
- Read
assets/templates/scripted/basic.Jenkinsfilefor node/stage patterns - Understand try-catch-finally structure for error handling
- Read
- Implement try-catch-finally for error handling
- ALWAYS validate using devops-skills:jenkinsfile-validator skill
3. Parallel/Matrix Pipelines
Use parallel {} block or matrix {} with axes {} for multi-dimensional builds.
- Default behavior is fail-fast for generated parallel pipelines (
parallelsAlwaysFailFast()or stage-levelfailFast true).
4. Security Scanning (DevSecOps)
Add SonarQube, OWASP Dependency-Check, Trivy stages with fail thresholds.
5. Shared Library Scaffolding
python3 scripts/generate_shared_library.py --name my-library --package org.example
Declarative Syntax Reference
Agent Types
agent any // Any available agent
agent { label 'linux && docker' } // Label-based
agent { docker { image 'maven:3.9.11-eclipse-temurin-21' } }
agent { kubernetes { yaml '...' } } // K8s pod template
agent { kubernetes { yamlFile 'pod.yaml' } } // External YAML
Environment & Credentials
environment {
VERSION = '1.0.0'
AWS_KEY = credentials('aws-key-id') // Creates _USR and _PSW vars
}
Options
options {
buildDiscarder(logRotator(numToKeepStr: '10'))
timeout(time: 1, unit: 'HOURS')
disableConcurrentBuilds()
timestamps()
parallelsAlwaysFailFast()
durabilityHint('PERFORMANCE_OPTIMIZED') // 2-6x faster for simple pipelines
}
Parameters
parameters {
string(name: 'VERSION', defaultValue: '1.0.0')
choice(name: 'ENV', choices: ['dev', 'staging', '
阅读完整来源 ↗