Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sheehan/job-dsl-gradle-example
An example Job DSL project that uses Gradle for building and testing.
https://github.com/sheehan/job-dsl-gradle-example
groovy jenkins job-dsl
Last synced: 6 days ago
JSON representation
An example Job DSL project that uses Gradle for building and testing.
- Host: GitHub
- URL: https://github.com/sheehan/job-dsl-gradle-example
- Owner: sheehan
- License: apache-2.0
- Created: 2014-02-06T23:12:38.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2022-04-21T02:40:44.000Z (almost 3 years ago)
- Last Synced: 2025-01-08T15:15:16.880Z (13 days ago)
- Topics: groovy, jenkins, job-dsl
- Language: Groovy
- Homepage:
- Size: 314 KB
- Stars: 447
- Watchers: 34
- Forks: 327
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Jenkins Job DSL Gradle Example
An example [Job DSL](https://github.com/jenkinsci/job-dsl-plugin) project that uses Gradle for building and testing. Check out [this presentation](https://www.youtube.com/watch?v=SSK_JaBacE0) for a walkthrough of this example (starts around 14:00).
## File structure
.
├── src
│ ├── jobs # DSL script files
│ ├── main
│ │ ├── groovy # support classes
│ │ └── resources
│ │ └── idea.gdsl # IDE support for IDEA
│ ├── scripts # scripts to use with "readFileFromWorkspace"
│ └── test
│ └── groovy # specs
└── build.gradle # build file
# Script Examples
* [Example 1](src/jobs/example1Jobs.groovy) - shows basic folder/job creation
* [Example 2](src/jobs/example2Jobs.groovy) - shows how to create a set of jobs for each github branch, each in its own folder
* [Example 3](src/jobs/example3Jobs.groovy) - shows how to use the configure block
* [Example 4](src/jobs/example4Jobs.groovy) - shows a way to reuse job definitions for jobs that differ only with a few properties
* [Example 5](src/jobs/example5Jobs.groovy) - shows how to pull out common components into static methods
* [Example 6](src/jobs/example6Jobs.groovy) - shows how to include script resources from the workspace
* [Example 7](src/jobs/example7Jobs.groovy) - shows how to create jobs using builders
* [Example 8](src/jobs/example8Jobs.groovy) - shows how to use DSL extensions provided by other plugins
## Testing
`./gradlew test` runs the specs.
[JobScriptsSpec](src/test/groovy/com/dslexample/JobScriptsSpec.groovy)
will loop through all DSL files and make sure they don't throw any exceptions when processed. All XML output files are written to `build/debug-xml`.
This can be useful if you want to inspect the generated XML before check-in. Plugins providing auto-generated DSL must be added to the build dependencies.
If you prefer to stub the auto-generated DSL, you can use [JobScriptsSpecAlternative](src/test/groovy/com/dslexample/JobScriptsSpecAlternative.groovy),
though you may miss some syntax errors.
## Seed Job
You can create the example seed job via the Rest API Runner (see below) using the pattern `jobs/seed.groovy`.
Or manually create a job with the same structure:
* Invoke Gradle script
* Use Gradle Wrapper: `true`
* Tasks: `clean test`
* Process Job DSLs
* DSL Scripts: `src/jobs/**/*Jobs.groovy`
* Additional classpath: `src/main/groovy`
* Publish JUnit test result report
* Test report XMLs: `build/test-results/**/*.xml`
Note that starting with Job DSL 1.60 the "Additional classpath" setting is not available when
[Job DSL script security](https://github.com/jenkinsci/job-dsl-plugin/wiki/Script-Security) is enabled.
## Other Resources
* [Job DSL Playground](http://job-dsl.herokuapp.com/) - App for debugging Job DSL scripts.
* [Job DSL API Viewer](https://jenkinsci.github.io/job-dsl-plugin/) - Full Job DSL syntax reference.
* [Job DSL REST Example](https://github.com/sheehan/job-dsl-rest-example) - Example that shows how to make Job DSL updates via the Jenkins REST API. Originally part of this repo, later split off.
#### Gradle Plugins
Plugins that automatically apply the functionality laid out in this example repo.
* [Gradle Job DSL Support Plugin](https://github.com/AOEpeople/gradle-jenkins-job-dsl-plugin) - Plugin for easy management of Jenkins Job DSL scripts with Gradle.
* [Gradle Jenkins Job DSL Plugin](https://github.com/heremaps/gradle-jenkins-jobdsl-plugin) - Plugin to manage Jenkins Job DSL projects in a Gradle project.