Skip to content

Commit

Permalink
Initial setup
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Oct 28, 2023
1 parent c47bf6c commit 4cb32a2
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 285 deletions.
8 changes: 4 additions & 4 deletions .docs/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
site_name: '"{{ name }}"'
site_description: '"{{ description }}"'
site_name: 'Kopy'
site_description: 'A compiler plugin to improve how to copy data classes with a nice DSL in Kotlin.'
site_author: 'Javier Segovia Córdoba'
remote_branch: gh-pages

repo_name: '"{{ repo }}"'
repo_url: 'https://github.com/JavierSegoviaCordoba/"{{ repo }}"'
repo_name: 'kopy'
repo_url: 'https://github.com/JavierSegoviaCordoba/kopy'

copyright: 'Copyright © 2021 Javier Segovia Córdoba'

Expand Down
54 changes: 0 additions & 54 deletions .github/workflows/build.yaml

This file was deleted.

70 changes: 0 additions & 70 deletions .github/workflows/initial-setup.yaml

This file was deleted.

36 changes: 1 addition & 35 deletions README.md
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
30 changes: 15 additions & 15 deletions gradle.properties
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 ###
####################################################################################################
Expand Down
107 changes: 0 additions & 107 deletions initial-setup.main.kts

This file was deleted.

0 comments on commit 4cb32a2

Please sign in to comment.