linkedin / play-parseq Goto Github PK

Hi folks, I have a Play application that is on Scala 2.13 and I'm not able to use play-parseq because it only builds artifacts for 2.11 and 2.12. It appears that the 2.12 artifact is not compatible with 2.13 due to differences in how scala.Serializable is implemented (there are likely more issues, that's just one example).

I'm happy to send a PR if we're open to expanding the cross-building versions to include 2.13.

These two sub-modules are not needed for publishing.

In order to cleanly integrate with CI can we get SBT automatically provisioned in a similar fashion as Gradle wrapper works? Does SBT has a concept of wrapper (or 'sbtw')?

@FranklinYinanDing, can you take a look at this a send a PR?

The artifacts are not showing in Maven Central. Contacted with Sonatype, they are not seeing traces on oss.sonatype.org. See here.

Now we've successfully published to Bintray. We need to include the project with JCenter then sync with Maven Central.

Problem statement

Let's automate the releases of play-parseq. Goals:

• releases to Maven Central to streamline consumption by the community (and to create more engaged community)
• release notes generation
• example LinkedIn OS project that has full release automation

Solution options

1. Automate SBT build
2. Migrate to Gradle and automate with Gradle plugins
3. Add Gradle for releases, delegate to SBT

Discussion (with @FranklinYinanDing):

• ad1) SBT is a dead. At LinkedIn we actively migrate to Gradle. SBT automation will duplicate Gradle automation we use in other projects.
• ad2) Migrate to Gradle is ideal but adds extra effort.
• ad3) Good pragmatic approach. We can get the releases automated without committing to full SBT->Gradle migration. We demonstrate how Gradle can wrap foreign build tool to automate releases. Risk exists that Gradle-SBT layer gets complicated and hard to maintain (if that happens we'll do option 2).

Implementation

I suggest to start using Shipkit Gradle plugins (http://shipkit.org) that Mockito community leverages to implement automated releases.

Suggested design

• Enable Travis CI
• Use and configure Shipkit Gradle plugins
  • Gradle will delegate to SBT to run build
  • Every PR merged to master will produce a new version in Maven Central
  • Documentation and release notes are automatically generated

Milestone 1

Automated releases to JCenter (very visible public repo)

• - SBT integration - #11 - @FranklinYinanDing
• - enable Travis CI job - #12 - @FranklinYinanDing
• - request admin rights to the project so that we can inspect / review / update Travis CI configuration.
• - Enable automated releases to Bintray - #10 - @mockitoguy
• - Document how releases work - #19 - @mockitoguy

Milestone 2

Automated releases to Maven Central, easy local testing.

• Convenient local testing (easy way to build local snapshot) - @mockitoguy
• Maven Central releases
  • - request Maven Central releases for "com.linkedIn.play-parseq" libraries - #18
• LinkedIn Artifactory releases (optional)

Thoughts / feedback?

Exciting!!! Let's get the releases fully automated and provide an example for other LinkedIn projects 🗡

Once we get admin rights to the project, let's setup Travis CI. I will provide travis config in PR #10 but it would be great if someone from the core team enabled Travis CI. This way you'll learning how to use Travis!

After successfully released, the artifacts are not fully imported in JCenter. Only one artifact play-parseq_2.12 got imported. See here.

To start publishing to Maven Central we need to follow the official guide:

http://central.sonatype.org/pages/ossrh-guide.html

@FranklinYinanDing, it's best if you or one of the team members do it. This way you'll learn the process and can manage/maintain it long term. I can help. The link above should get you a good start. Once you created project for Maven Central, you can generate key+password and we will use to configure Shipkit to automatically publish to Maven Central.

Let's add content to README.md and document how releases work.

Travis CI timed out when publishing.

@FranklinYinanDing, can you make following local test on clean checkout of play-parseq?

export BINTRAY_API_KEY=your-secret
./gradlew bintrayUpload -PdryRun
./gradlew bintrayUpload

Above should work and should publish to LinkedIn Bintray test repo (https://bintray.com/linkedin/test-repo/play-parseq).

Once we get Bintray publications working we can:

• delete v.0.8.1 tag & push
• revert v.0.8.1 code push performed by Shipkit & push
• trigger Travis to build new version

Once we get Travis to automatically publish without problems we can:

• clean up the repo again (remove tag and automated commit)
• change the 'test-repo' to 'maven' in shipkit.gradle & push
• observe how Travis builds new version and ships to JCenter :D

Then, let's work on Maven Central releases.