Giter Club home page Giter Club logo

librarian's Introduction

Librarian is a library to help building Kotlin libraries.

Features:

Quickstart

Work in progress...

Add librarian to your Gradle buildscript classpath:

plugins {
  id("com.gradleup.librarian").version("0.0.2")
}

Call librarianRoot in your root module:

librarianRoot()

And librarianModule in each library module:

librarianModule()

Librarian uses Gradle properties for configuration options and environment variables for secrets:

# gradle properties

# compatibility
librarian.javaCompatibility=8
librarian.kotlinCompatibility=2.0.0

# kdoc
librarian.kdoc.aggregator=kdoc
librarian.kdoc.olderVersions=

# version
librarian.version.packageName=com.apollographql.mockserver

# publishing
librarian.sonatype.backend=S01
librarian.pom.groupId=com.apollographql.mockserver
librarian.pom.version=0.0.1
librarian.pom.description=Apollo Mockserver
librarian.pom.vcsUrl=https://github.com/apollographql/apollo-kotlin-mockserver
librarian.pom.developer=Apollo Kotlin Mockserver contributors
librarian.pom.license=MIT License
librarian.pom.licenseUrl=https://raw.githubusercontent.com/apollographql/apollo-kotlin-mockserver/main/LICENSE
export LIBRARIAN_SIGNING_PRIVATE_KEY=your_gpg_key
export LIBRARIAN_SIGNING_PRIVATE_KEY_PASSWORD=your_gpg_key_password

export LIBRARIAN_SONATYPE_USERNAME=your_sonatype_username
export LIBRARIAN_SONATYPE_PASSWORD=your_sonatype_password

librarian's People

Contributors

martinbonnin avatar

Stargazers

Sebastian Heil avatar Christoph avatar Oleg Nenashev avatar Raphi avatar Sebastian Schuberth avatar Mateusz Kwieciński avatar

Watchers

Said Tahsin Dane avatar Alex Nordlund avatar Louis CAD avatar avatar

librarian's Issues

Make `prepare-release` more transactional

If a step fails, it should be as side-effect free as possible. For an example right now it can leave the prepare-release-xxx branches behind, which in turn makes a re-run fail.

Exception in thread "main" java.lang.IllegalStateException: command gh pr merge bump-0.0.4 --squash --auto --delete-branch failed with output: 

Exception in thread "main" java.lang.IllegalStateException: command gh pr merge bump-0.0.4 --squash --auto --delete-branch failed with output:

	at com.gradleup.librarian.core.tooling.Tag_and_bumpKt.runCommand(tag-and-bump.kt:70)
	at com.gradleup.librarian.core.tooling.Tag_and_bumpKt.mergeAndWait(tag-and-bump.kt:123)
	at com.gradleup.librarian.core.tooling.Tag_and_bumpKt.tagAndBump(tag-and-bump.kt:51)
	at com.gradleup.librarian.cli.command.TagAndBump.run(TagAndBump.kt:92)
	at com.gradleup.librarian.cli.command.AbstractTagAndBump.run(TagAndBump.kt:80)
	at com.github.ajalt.clikt.parsers.Parser.parse(Parser.kt:198)
	at com.github.ajalt.clikt.parsers.Parser.parse(Parser.kt:211)
	at com.github.ajalt.clikt.parsers.Parser.parse(Parser.kt:18)
	at com.github.ajalt.clikt.core.CliktCommand.parse(CliktCommand.kt:400)
	at com.github.ajalt.clikt.core.CliktCommand.parse$default(CliktCommand.kt:397)
	at com.github.ajalt.clikt.core.CliktCommand.main(CliktCommand.kt:415)
	at com.github.ajalt.clikt.core.CliktCommand.main(CliktCommand.kt:440)
	at com.gradleup.librarian.cli.MainKt.main(main.kt:6)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.