Skip to content

Commit c8980da

Browse files
committed
add release instructions
1 parent 5459d89 commit c8980da

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,19 @@ To debug the compiler, you can write the code you want to test and then run
2020
./gradlew :integration-tests:ksp:test --no-daemon -Dorg.gradle.debug=true -Dkotlin.compiler.execution.strategy=in-process
2121
```
2222
Then you can create and run a remote run configuration in intellij to attach the debugger.
23+
24+
## Releasing
25+
26+
In order to publish a release, follow the following steps:
27+
1. create a branch named: release/<version>
28+
2. Ensure all changes are listed in CHANGELOG.md
29+
3. Update the kotlin-inject version in gradle/libs.versions.toml to the release version, removing the SNAPSHOT suffix
30+
4. Run ./gradlew patchChangelog
31+
5. Update the version in the README
32+
6. Create a pull request with those changes
33+
7. Merge, CI should create a GitHub release and publish to maven central
34+
8. On the same branch, update the kotlin-inject version again, adding back the SNAPSHOT suffix
35+
9. Create a second pull request & merge
2336

2437
---
2538

0 commit comments

Comments
 (0)