Plugin Information |
---|
View Pretested Integration on the plugin site for more information. |
Developed by
Sponsored by
Introduction
The Pretested Integration Plugin offers a branchy approach to pretested integration (also known as pre-tested commits), which upholds the invariant; that for a specific branch, known as the integration branch, all commits have been verified.
This plugin is developed by Praqma and sponsored by Atmel - It's maintained in the scope of Joint Open Source Roadmap Alliance (JOSRA).
The plugin rely on the SCM plugin to establish the workspace and then takes over to do the integration. Last the job make the decision whether to like and commit the result or hate and discard it. To get a comprehensive introduction to how the plugin relies on the SCM plugin please read the blog post at the JOSRA: Pretested Integration Plugin.
References
- For more background information and a discussion on the different merge strategies available please read the blog post at the JOSRA: Pretested Integration Plugin.
- For a Paper on how to implement at complete flow of automated continuous delivery - including pretested integration read the white paper: CoDe:U Git Flow - a Continuous Delivery Approach (PDF) or blog post: An Automated Git Branching Flow
- To follow the roadmap for this plugin see the Trello board.
- Developer oriented documentation is found in the repository readme.
The recommend setup and git workflow
Here is a simple git workflow where you can work on a features branch, and when ready push to a ready-branch. The Pretested Integration plugin, if configured as described will then pick up your changes, merge them and verify them. If verified they are integrated on the integration branch. The ready branch are automatically deleted if integration was successful.
Recommendation:
- Use one repository in your job configuration - the integration repository. Avoid using several repositories - model your dependencies in other (better) ways.
- Use master as integration branch (destination).
- Use ready/** as specifier for ready branches - only branches matching this expression will trigger the build
The simple plugin configuration
To configure the plugin to pick up ready branches, verify them and deliver them to the integration branch use the following configuration:
|
Configure the SCM as above.
|
|
Configure the Pretested Integration plugin with integration branch 'master' and the named repository 'origin'. |
Now you only need to configure your definition of done - the verification. How should the job verify the commits? It can be compile and measure compiler warning, build and run unit tests and check that coverage do not drop.
The simple Git workflow
Get your repository up to date:
git fetch --prune git checkout master git pull origin master
Create a feature- or development- or... branch
git checkout -b feat_1337-improved-login-screen
...work, stage and commit changes.
Then push changes to a ready branch, which is basically just a branch following a naming conventions for branches matching ready/**.
git push origin feat_1337-improved-login-screen:ready/feat_1337-improved-login-screen
The change will be picked up by the plugin if configured as shown in next section.
- You can then delete your local branch and continue with a new feature or development branch.
- You are free to push to any branch name not matching the ready branch naming convention without triggering an integration build.
Using multiple repository configurations
The plugin can be used in jobs with multiple repositories configured in the jobs, but there can be only one integration repository. The plugin is designed to work on only one repository, you can integrate on several repositories a once.
Recommendations for multiple repository jobs
More info will come with release 2.2.0....
Using with Git SCM plugin
More info will come with release 2.2.0....
Using with MultiSCM plugin
More info will come with release 2.2.0....
Acknowledgement
Code contributions were initially made by Computer Science students at University of Copenhagen as part of a study project
Ronni Elken Lindsgaard
Alexander Winther Uldall
Esben Skaarup
Andreas Frisch
Issues
Changes
Version 2.1.2:
- Implemented logging tracing
Version 2.1.1:
- Bugfix for running on slaves (JENKINS-24844)
Version 2.1.0:
- Protected master branch (Plugin tries to delete origin/master JENKINS-24286)
- Re-using last commit message in accumulated strategy (Improve commit message JENKINS-24285)
- Removed the "origin" from the description (JENKINS-24284)
- When squashing commits, now using author from tip of branch (JENKINS-24443)
- Additional tests added as well
Version 2.0:
- Git integration is now supported
Version 1.1:
- Dependency of Mercurial plugin set to 1.39 due to previous failure to trigger on merge commits
- Removed UI elements that should not have been there
Version 1.0:
- Release of the first stable versionI