jenkinsfile

Best Practices

• Use Declarative Pipeline syntax with pipeline { agent ... stages { ... } } unless Scripted is explicitly requested
• Define explicit agent (e.g., agent any, agent { docker 'image' }, agent { label 'node' })
• Organize work into logical stages (Build, Test, Deploy) with clear separation of concerns
• Use environment block for environment variables, never hardcode values in steps
• Use credentials() helper for secrets — never hardcode credentials or tokens
• Add post block with always (cleanup), success (notifications), failure (alerts) sections
• Use when directives to conditionally run stages (branch, expression, changeset, tag)
• Use parameters block for user-configurable builds (choice, string, booleanParam)
• Use tools block to auto-install JDK, Maven, Gradle, Node.js from Jenkins Global Tool Configuration
• Add timeout and retry for flaky steps, wrap deployments in timeout { ... }
• Use stash/unstash or archiveArtifacts for passing files between stages and nodes
• Use parallel blocks for concurrent test execution across platforms or configurations
• Use options block (buildDiscarder, timestamps, disableConcurrentBuilds, skipStagesAfterUnstable)
• For shared libraries, use vars/ for global DSL steps with def call() method pattern