https://github.com/rbusarow/gradle-template
https://github.com/rbusarow/gradle-template
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rbusarow/gradle-template
- Owner: RBusarow
- License: apache-2.0
- Created: 2021-09-16T01:03:35.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-11-30T02:19:30.000Z (over 4 years ago)
- Last Synced: 2025-12-07T11:31:54.106Z (7 months ago)
- Language: Kotlin
- Size: 2.14 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Gradle Project Template
This is still a work-in-progress
### Features
- Automatic [Dependabot] updates
- Automatic merging via [Kodiak](https://kodiakhq.com)
- Docusaurus website
- Automatic website deployment after updates to `main`
- CI invokes Detekt, KTLint with automatic formatting, and `testJvm` (all JVM unit tests)
- If KTLint generates changes, those changes are automatically pushed into the PR and CI is restarted
- CI automatically cancels stale jobs
- Automatic release draft updates using [Release Drafter](https://github.com/release-drafter/release-drafter)
### Setup
1. set up docusaurus
```shell
cd website
npm install
cd ..
```
2. search and replace **all files** (not just `*.kt*`):
- `TEMPLATE_PROJECT_NAME` -> project's GitHub name
- `TEMPLATE_DOMAIN` -> project's domain
- `TEMPLATE_GITHUB_USER` -> GitHub username
- `TEMPLATE_AUTHOR_NAME` -> author name, like "John Smith"
3. create a GitHub secret for GH Actions named `PERSONAL_ACCESS_TOKEN`
4. install Kodiak
5. create labels for `automerge` and `dependencies`
6. set a branch protection
### TODO
- [ ] handle search and replace with a shell script
[Dependabot]: https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates