generated from JavierSegoviaCordoba/kotlin-template-javiersc
-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c47bf6c
commit 4cb32a2
Showing
6 changed files
with
20 additions
and
285 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1 @@ | ||
# 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. | ||
# Kopy |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,30 @@ | ||
#################################################################################################### | ||
### CONFIGURATION ### | ||
#################################################################################################### | ||
root.project.name="{{ root_project_name }}" | ||
main.project.name="{{ main_project_name }}" | ||
project.group="{{ project_group }}" | ||
root.project.name=kopy | ||
main.project.name=kopy-compiler | ||
project.group=com.javiersc.kotlin.kopy | ||
#################################################################################################### | ||
### CODE ANALYSIS ### | ||
#################################################################################################### | ||
#TODO: analysis.qodana.projectKey= | ||
analysis.sonar.organization="{{ sonar_organization }}" | ||
analysis.sonar.projectKey="{{ project_group }}" | ||
analysis.sonar.projectName="{{ root_project_name }}" | ||
analysis.sonar.organization=javiersc | ||
analysis.sonar.projectKey=com.javiersc.kotlin.kopy | ||
analysis.sonar.projectName=kopy | ||
#################################################################################################### | ||
### POM ### | ||
#################################################################################################### | ||
pom.name="{{ name }}" | ||
pom.description="{{ description }}" | ||
pom.url=https://github.com/"{{ github_username }}"/"{{ repo }}" | ||
pom.name=Kopy | ||
pom.description=A compiler plugin to improve how to copy data classes with a nice DSL in Kotlin. | ||
pom.url=https://github.com/JavierSegoviaCordoba/kopy | ||
pom.license.name=The Apache License, Version 2.0 | ||
pom.license.url=https://www.apache.org/licenses/LICENSE-2.0.txt | ||
pom.developer.id="{{ github_username }}" | ||
pom.developer.name="{{ username }}" | ||
pom.developer.email="{{ email }}" | ||
pom.scm.url=https://github.com/"{{ github_username }}"/"{{ repo }}" | ||
pom.scm.connection=scm:git:[email protected]:"{{ github_username }}"/"{{ repo }}".git | ||
pom.scm.developerConnection=scm:git:[email protected]:"{{ github_username }}"/"{{ repo }}".git | ||
pom.developer.id=JavierSegoviaCordoba | ||
pom.developer.name=Javier Segovia Cordoba | ||
pom.developer.email=[email protected] | ||
pom.scm.url=https://github.com/JavierSegoviaCordoba/kopy | ||
pom.scm.connection=scm:git:[email protected]:JavierSegoviaCordoba/kopy.git | ||
pom.scm.developerConnection=scm:git:[email protected]:JavierSegoviaCordoba/kopy.git | ||
#################################################################################################### | ||
### Gradle ### | ||
#################################################################################################### | ||
|
This file was deleted.
Oops, something went wrong.