celebrating-contributors.md

Celebrating contributors

See also "How Shipkit Works" documentation index. Please help us with docs and submit a PR with improvements!

Celebrating and appreciating contributors is important to build an engaged community around the Open Source project. Shipkit automatically includes contributors in the release notes and in "pom.xml" file.

Contributors in pom.xml

When release is performed, Shipkit Gradle tasks query GitHub API to get a list of all contributors of the project. Contributors are included in generated "pom.xml" file:

  ...
  <developers>
    <developer>
      <id>mockitoguy</id>
      <name>Szczepan Faber</name>
      <roles>
        <role>Core developer</role>
      </roles>
      <url>https://github.com/mockitoguy</url>
    </developer>
    <developer>
      <id>bric3</id>
      <name>Brice Dutheil</name>
      <roles>
        <role>Core developer</role>
      </roles>
      <url>https://github.com/bric3</url>
    </developer>
    ...
  </developers>
  <contributors>
    <contributor>
      <name>Marcin Zajączkowski</name>
      <url>https://github.com/szpak</url>
    </contributor>
    ...

Using GitHub we cannot reliably identify core developers (full commit rights) from all contributors. Therefore developers of the project can be configured in shipkit file (example shipkit.gradle):

shipkit {
  ...
  team.developers = ['mockitoguy:Szczepan Faber', 'wwilk:Wojtek Wilk']
}

Contributors in release notes

Release notes list contributors by name. We show the number of commits and link to contributor's GitHub page.

2.11.3 (2017-10-28) - 1 commit by Allon Murienik - published to

• InvocationsPrinter string concatination (#1231)

2.11.2 (2017-10-22) - 7 commits by Rafael Winterhalter (6), Allon Murienik (1) - published to

• Updated Byte Buddy and ASM dependencies. Fixes #1215. (#1218)
• Fixes #1183: Make override check more forgiving to accomondate Kotlin compile patterns. (#1217)
• Adresses #1206: allow opting out from annotation copying within mocks. (#1216)
• ClassFormatError when trying to mock certain interfaces (#1215)
• Standardize JUnit imports (#1213)
• Mockito should not copy annotations in all cases (#1206)
• UnfinishedVerificationException with Kotlin after updating to 2.9.0 (#1183)

User guide

Tasks that generate contributors information are automatically triggered when performRelease or ciPerformRelease tasks run. More tasks:

• During development we can preview the release notes of the next version: ./gradlew updateReleaseNotes -Ppreview
• We can also preview the release notes file: ./gradlew updateReleaseNotes
• To view the "pom.xml" file with contributors information: ./gradlew build, faster (no checks): ./gradlew build -x check, even faster (just the pom task): ./gradlew generatePomFile

Thank you for reading! Questions or feedback? Start discussion by opening a ticket in GitHub!