Giter Club home page Giter Club logo

semver-mp.kt's Introduction

Stand With Ukraine

semver.kt

semver.kt

Build Status Issues GitHub Top Lang Awesome Kotlin Licence

NB! This is still in pre-release, thus breaking changes between minor versions are to be expected until first stable release. At the same time, the functionality is covered extensively with tests, and I'm also using the gradle plugin in my other projects (see e.g. kotlin-faker/settings.gradle.kts), so it's possible to use both the libraries and the gradle plugin already.

About

This repo contains three modules which can be used separately:

Why?

I've been using the gradle-semantic-build-versioning plugin for my gradle-based projects, and it works great for the most part. Unfortunately the project has not been maintained since late 2019, the author does not reply to open issues, and gradle has pretty strict rules on publishing forks of plugins. Therefore, I've decided to re-write my own plugin using Kotlin.

I like monorepo approach when it makes sense, so I decided to keep all the necessary code in one single repo. At the same time I think it could be useful to publish the "core" APIs (semver-spec and semver-release) as separate artifacts instead of having all the code within the plugin sources. This would allow to easily add a similar maven plugin in the future provided there's interest, using the same APIs. And at the same time these APIs could also be useful to someone else as standalone artifacts which can be used in other projects?

Why not XXX?

I've found that alternatives do not really satisfy my needs and wants. For example, the popular semantic-release works great for JS projects, but is kind of a pain when used in JVM-based projects.

In addition, I want to expand on the idea of avoiding hardcoded versions in build files as this seems completely unnecessary since versions are also stored as git objects (tags, or sometimes branches). This is something that I don't see very often in other existing tools which tend to write versions to the build files, and which was one of the things that I really liked about the aforementioned 'gradle-semantic-build-versioning' plugin.

Usage

Each of the modules can be used separately either as a library by declaring a dependency or as a gradle plugin. For module-specific usage details see modules' respective README files.

Requirements

  • java >= 8
  • kotlin >= 1.6
  • gradle >= 7.5 (for :semantic-versioning plugin)

semver-mp.kt's People

Contributors

serpro69 avatar

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.