Bitfunk Gradle Plugins¶

About the project¶

A Collection of Gradle plugins to simplify and unify project development used across multiple bitfunk projects. They add opinionated configuration for other plugins or new functionality.

Plugins¶

Plugins and tools that support developing software and add functionality to Gradle.

Quality¶

• Quality Collection - a collection of all quality plugins
• Code Analysis - a source code analysis plugin
• Formatter - a source code formatter plugin applying bitfunk code style
• Report - a quality report plugin using sonarqube

Tool¶

• CompositeDelegator - a plugin that delegates gradle tasks execution to included builds
• Publish - a publish plugin for maven publications
• GitVersion - a plugin to derive version information from git tags
• Versioning - a versioning plugin using git tags

Plugin development¶

Plugins and tools that support developing Gradle plugins.

Plugin¶

• GradlePluginConvention - a convention plugin for Gradle plugin development to ease configuration
• VersionCatalogAccessor - a version catalog accessor for Gradle plugin development

Test¶

• GradleTestUtil - Test util to ease Gradle plugin testing

Getting started¶

You could use individual plugins or the all-plugins collection.

Check the usage of each Gradle plugin by reading the plugin documentation.

Requirements¶

• Gradle 7.2+
• Java 11

Installation¶

The dependencies are distributed through Maven Central. In case you want to use a SNAPSHOT version, add the following to your project root build.gradle/build.gradle.kts file:

buildscript {
    repositories {
        maven("https://s01.oss.sonatype.org/content/repositories/snapshots/")
    }
}

Usage¶

Apply the plugins of your choice to your project. For details refer to the plugins overview.

Roadmap¶

This project is work in progress. We are working on adding more functionality, guidelines, documentation and other improvements.

See the open issues for a list of proposed improvements and known issues.

Changelog¶

All notable changes to this project will be documented in the changelog.

Versioning¶

We use Semantic Versioning as a guideline for our versioning.

Contributing¶

You want to help or share a proposal? You have a specific problem? Report a bug or request a feature.

You want to fix or change code? Read the Code of Conduct and contributing guide.

Releasing¶

See release guide.

Copyright and license¶

Copyright © 2022 Wolf-Martell Montwé.

Please refer to the ISC License for more information.