Further refine our docs
diff --git a/README.md b/README.md index 12cfc9d..7cf50fe 100644 --- a/README.md +++ b/README.md
@@ -124,8 +124,8 @@ ```python rules_kotlin_extensions = use_extension("@rules_kotlin//src/main/starlark/core/repositories:bzlmod_setup.bzl", "rules_kotlin_extensions") rules_kotlin_extensions.kotlinc_version( - version = "1.6.21", # just the numeric version - sha256 = "632166fed89f3f430482f5aa07f2e20b923b72ef688c8f5a7df3aa1502c6d8ba" + version = "2.1.20", + sha256 = "a118197b0de55ffab2bc8d5cd03a5e39033cfb53383d6931bc761dec0784891a" ) use_repo(rules_kotlin_extensions, "com_github_google_ksp", "com_github_jetbrains_kotlin", "com_github_jetbrains_kotlin_git", "com_github_pinterest_ktlint", "kotlinx_serialization_core_jvm", "kotlinx_serialization_json", "kotlinx_serialization_json_jvm") ``` @@ -136,8 +136,8 @@ kotlin_repositories( compiler_release = kotlinc_version( - release = "1.6.21", # just the numeric version - sha256 = "632166fed89f3f430482f5aa07f2e20b923b72ef688c8f5a7df3aa1502c6d8ba" + release = "2.1.20", + sha256 = "a118197b0de55ffab2bc8d5cd03a5e39033cfb53383d6931bc761dec0784891a" ) ) ``` @@ -147,12 +147,11 @@ Third party (external) artifacts can be brought in with systems such as [`rules_jvm_external`](https://github.com/bazelbuild/rules_jvm_external) or [`bazel_maven_repository`](https://github.com/square/bazel_maven_repository) or [`bazel-deps`](https://github.com/johnynek/bazel-deps), but make sure the version you use doesn't naively use `java_import`, as this will cause bazel to make an interface-only (`ijar`), or ABI jar, and the native `ijar` tool does not know about kotlin metadata with respect to inlined functions, and will remove method bodies inappropriately. Recent versions of `rules_jvm_external` and `bazel_maven_repository` are known to work with Kotlin. -# Development Setup Guide -As of 1.5.0, to use the rules directly from the rules_kotlin workspace (i.e. not the release artifact) - require the use of `release_archive` repository. This repository will build and configure the current -workspace to use `rules_kotlin` in the same manner as the released binary artifact. +## Development Setup -In the project's `MODULE.bazel`, change the setup: +For local development of rules_kotlin: + +#### With Bzlmod ```python local_path_override( @@ -161,19 +160,16 @@ ) ``` -To use rules_kotlin from head without cloning the repository, (caveat emptor, of course), change the -rules to this: +#### From HEAD (Bzlmod) ```python -_RULES_KOTLIN_VERSION = "b2bbb8b287a2dd5c7f8bf0af03908bcd573d176e" +_RULES_KOTLIN_COMMIT = "HEAD_COMMIT_SHA" archive_override( module_name = "rules_kotlin", - integrity = "sha256-0ijRsnrdfRJOs4IUnXUNKksyH/zi1um/JninjHq6Pyg=", - strip_prefix = "rules_kotlin-%s" % _RULES_KOTLIN_VERSION, - urls = [ - "https://github.com/bazelbuild/rules_kotlin/archive/%s.tar.gz" % _RULES_KOTLIN_VERSION, - ], + integrity = "sha256-...", + strip_prefix = "rules_kotlin-%s" % _RULES_KOTLIN_COMMIT, + urls = ["https://github.com/bazelbuild/rules_kotlin/archive/%s.tar.gz" % _RULES_KOTLIN_COMMIT], ) ```