https://github.com/javiersegoviacordoba/kotlin-template-javiersc

Create libraries for all types of Kotlin projects: android, JVM, Multiplatform, Gradle plugins, and so on.
https://github.com/javiersegoviacordoba/kotlin-template-javiersc

android android-library changelog cicd docs github-template gradle-kotlin-dsl gradle-plugin hacktoberfest kotlin kotlin-android kotlin-dsl kotlin-jvm kotlin-multiplatform kotlin-script kotlin-template maven-publish repo-template

Last synced: 11 days ago
JSON representation

Create libraries for all types of Kotlin projects: android, JVM, Multiplatform, Gradle plugins, and so on.

• Host: GitHub
• URL: https://github.com/javiersegoviacordoba/kotlin-template-javiersc
• Owner: JavierSegoviaCordoba
• Created: 2021-10-24T03:25:56.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-10T17:14:57.000Z (28 days ago)
• Last Synced: 2024-10-11T10:16:44.175Z (27 days ago)
• Topics: android, android-library, changelog, cicd, docs, github-template, gradle-kotlin-dsl, gradle-plugin, hacktoberfest, kotlin, kotlin-android, kotlin-dsl, kotlin-jvm, kotlin-multiplatform, kotlin-script, kotlin-template, maven-publish, repo-template
• Language: Kotlin
• Homepage:
• Size: 156 KB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# JavierSC Kotlin template

Create libraries for all types of Kotlin projects: android, JVM, Multiplatform, Gradle plugins, and

so on.

## Features

- Easy to publish:

  - Kotlin JVM

  - Kotlin Multiplatform

  - Android library

  - Gradle Plugins

  - Version Catalog

- Versioning based on git tags

- Multiple patching tasks for CHANGELOG

- Autogenerate docs for all projects

- Code analysis with default config

- Code formatter with default config

- Autogenerate and update README badges

- Autogenerate a Version Catalog with all projects in the project

- GitHub Actions:

  - Publish all types of artifacts (MavenCentral and Gradle Plugin Portal)

  - Publish as snapshot any new push to main branch.

  - Show Detekt hints in pull requests (below code that smells)

  - Automatically patch the CHANGELOG and publish all docs to GitHub pages

  - Add new updates to the CHANGELOG when the PR is open by Renovate

## Usage

1. Go to the GitHub Actions tab

2. Select `initial-setup`

3. Press `Run workflow`

4. Fill the workflow form

After that, there will be a new commit modifying/deleting all necessary files.