Java Groovy Shell

README.md

Shipkit

Build Status

Documentation

Imagine

You will be more productive if your releases are fully automated and happen on every change. You will build great product if you can focus on code & features, but not on the release overhead. Shipkit will make it happen. Shipkit is a toolkit for shipping it.

Every team should be empowered to develop with rapid velocity, frictionless releases and semantic versioning just like we do it in Mockito. Shipkit enables Mockito to automatically publish new versions to 2M Mockito users!

Fully automated releases are only the first part of the journey...

Imagine the world where you call pull in a new version of some Open Source library and not worry if it breaks compatibility. Imagine that you can submit a pull request to some project, have it reviewed timely, and have the new version with your fix available to you in minutes after your PR is merged. Imagine that for any dependency you consider upgrading, you can view its neatly and consistently maintained release notes. Imagine that you can set up practical Continuous Delivery automation in your project in minutes, by using a well behaving and documented Gradle plugin. Imagine that you can focus on code and features while the release management, versioning, publishing, release notes generation is taken care for you automagically.

This is the goal of "Shipkit" project.

Customers

Using Shipkit? Submit a pull request and add your project to the list!

Help us!

If the vision of the project connects with you help us!!!

  • Open a new GitHub ticket to start the conversation. We love feedback, brainstorming and discussions.
  • Drop a comment to one of the existing "please contribute" tickets, and tell us that you are interesting in implementing it.
  • Try out Shipkit in your project and give feedback
  • If you like emails, join the mailing list, but be warned that we rarely use emails, and prefer GitHub tickets.
  • Spread the word about Shipkit, let us know about other projects with similar goals.

Features

Currently, Shipkit offers Gradle plugins for automating releases of Java libraries and Gradle plugins. Basic use case is simple: You have code that wants to be delivered to your customers, Shipkit has tools to help you out:

  • automatic version bumps in "version.properties" file - don’t waste time managing your version manually
  • automatically generated release notes in markdown - offer your customer clean information what changed and why
  • automatic including contributors in pom.xml - appreciate the community
  • release notes that highlight each individual contributor by name - build engaged community
  • avoiding publishing binaries if nothing changed - respect your customers’ time
  • automatic shipping to Bintray and Maven Central - use every opportunity to give your product to the hands of customers
  • keeping secure tokens safe - masks sensitive values from logging and error messages from underlying tools like git
  • and all that in a sweet little package, fully integrated, neatly automated, easy to roll out

For details see "How Shipkit Works?"

Quick start

Add Gradle plugin:

plugins {
  // TODO: Use latest version from https://plugins.gradle.org/plugin/org.shipkit.java
  id "org.shipkit.java" version "0.9.79"
}

Initialize:

./gradlew initShipkit

Perform release:

./gradlew performRelease

For more and detailed information see docs/getting-started.md

History

  • 2014, August - we set up automated continuous delivery for Mockito project, every merged pull requested produced release notes and new version in Maven Central. We still do it today in Mockito!
  • 2016, November - we pushed out the release automation toolkit to a separate project in GitHub, called "mockito-release-tools". We really needed to do that! As much as useful the toolkit was to drive Mockito releases, we needed to make it reusable, well documented, and packaged as a separate binary.
  • 2017, February - Marcin Stachniuk joins the team, implements automatic fetching of contributors from GitHub and starts working on automatic e2e testing of library clients.
  • 2017, March - Shipkit mentioned in DevoxxUS'17 conference in San Jose, "Great tools for engineers: even cleaner tests with Mockito 2" talk (video)
  • 2017, March - Wojtek Wilk joins the team, implements release avoidance when binaries aren't changed in comparison to previous release, starts driving API compatibility validation and Shipkit dogfooding.
  • 2017, April - we found a neat name for our project: "Shipkit", a toolkit for shipping it! We registered the domain: http://shipkit.org
  • 2017, May - there are 5 contributors in total, we expanded the vision of the project, and currently working on killer features like: automated e2e testing with library consumers + automated pushes of version upgrades #85, A/B testing of build results when upgrading dependencies.
  • 2017, June - "Ship every change to production!" presentation at Software Architecture conference in Santa Clara, CA (abstract).
  • 2017, June - Szczepan includes information about Shipkit in his presentation at Gradle Summit conference in Palo Alto, CA. (abstract, slides, video)
  • 2017, July - Shipkit presented at Confitura '17 conference in Warsaw (abstract, slides, video)
  • 2017, July/August - Shipkit presentations at JUG meetups in Poland: all abstracts, Krakow (slides), Wroclaw (slides), and Bielsko-Biala (slides).
  • 2017, October - Shipkit mentioned in JavaOne '17 conference in San Francisco in 2 talks:
    • "You Deserve Great Tools: Commit-to-Production Automation at LinkedIn" (summary, video, slides)
    • "You Deserve Great Tools: Mockito 2 for Cleaner Tests and Enhanced Productivity" (summary, slides). There was no video taken at JavaOne but this talk was recorded at DevoxxUS'17 conference (video).
  • 2017, November - Shipkit mentioned in QCon '17 conference in San Francisco, "CI/CD at scale: lessons from LinkedIn and Mockito" talk (slide clip).

Want to include your event? Submit a pull request!

Plans

  • 2017, October - Szczepan has 3 talks at JavaOne (San Francisco). Mockito productivity talk will mention Shipkit. Other talks: Engineering at scale with Gradle and Play Framework at LinkedIn, Commit-to-production pipeline at LinkedIn (TODO link).
  • 2017, October - we plan to release 1.0-milestone-1 of Shipkit.
  • 2017, November - Szczepan's continous delivery talk at QCon (San Franciso), will include Mockito use of Shipkit.
  • 2017, Q4 - 1.0 release.
  • 2018, helping community adopt Shipkit while adding writing great features on the way!