bazel-contrib
diff --git a/‎.gitignore‎
Lines changed: 4 additions & 1 deletion b/‎.gitignore‎
Lines changed: 4 additions & 1 deletion
diff --git a/‎scripts/README.md‎
Lines changed: 80 additions & 35 deletions b/‎scripts/README.md‎
Lines changed: 80 additions & 35 deletions
@@ -10,4 +10,7 @@ hash2
 .vscode
 unformatted-*.backup.scala
 .scala-build
-test/semanticdb/tempsrc
+test/semanticdb/tempsrc
+
+# From scripts/create_repository.py
+repository-artifacts.json
@@ -6,56 +6,101 @@
 - [Debugging](#debugging)
 - [Requirements](#requirements)
 
-### About
-The script allows to update a certain scala_x_x.bzl file and its content (artifact, sha, dependencies), by changing the value of `root_scala_version` variable.
-It can be used to create non-existent file for chosen Scala version. <br>
-It's using a [https://get-coursier.io/docs/](coursier) in order to **resolve** lists the transitive dependencies of dependencies and **fetch** the JARs of it.
-
-### Usage
-Usage from `/rules_scala/scripts`:
-````
-python3 create_repository.py
-````
-
-### Examples
-Current value of `root_scala_versions`:
+## About
+
+The script allows to update a certain scala_x_x.bzl file and its content
+(artifact, sha, dependencies), by changing the value of `root_scala_version`
+variable.
+
+It can be used to create non-existent file for chosen Scala version.
+
+It's using a [https://get-coursier.io/docs/](coursier) in order to **resolve**
+lists the transitive dependencies of dependencies and **fetch** the JARs of it.
+
+## Usage
+
+Usage from the rules_scala root directory:
+
+```sh
+./scripts/create_repository.py
 ```
-root_scala_versions = ["2.11.12", "2.12.19", "2.13.14", "3.1.3", "3.2.2", "3.3.3", "3.4.3", "3.5.0"]
+
+## Examples
+
+Current value of `root_scala_versions`:
+
+```py
+root_scala_versions = [
+    "2.11.12",
+    "2.12.19",
+    "2.13.14",
+    "3.1.3",
+    "3.2.2",
+    "3.3.3",
+    "3.4.3",
+    "3.5.0",
+]
 ```
 
 To **update** content of `scala_3_4.bzl` file:
-```
-root_scala_versions = ["2.11.12", "2.12.19", "2.13.14", "3.1.3", "3.2.2", "3.3.3", "3.4.4", "3.5.0"]
-                                                                                   ^^^^^^^ <- updated version
+
+```py
+root_scala_versions = [
+    "2.11.12",
+    "2.12.19",
+    "2.13.14",
+    "3.1.3",
+    "3.2.2",
+    "3.3.3",
+    "3.4.4",  # <- updated version
+    "3.5.0"
+]
 ```
 
 To **create** new `scala_3_6.bzl` file:
-```
-root_scala_versions = ["2.11.12", "2.12.19", "2.13.14", "3.1.3", "3.2.2", "3.3.3", "3.4.3", "3.5.0", "3.6.0"]
-                                                                                                     ^^^^^^^ <- new version
-```
 
-### Debugging
-Certain dependency version may not have a support for chosen Scala version e.g.
+```py
+root_scala_versions = [
+    "2.11.12",
+    "2.12.19",
+    "2.13.14",
+    "3.1.3",
+    "3.2.2",
+    "3.3.3",
+    "3.4.3",
+    "3.5.0",
+    "3.6.0",  # <- new version
+]
 ```
+
+## Debugging
+
+Certain dependency versions may not support a specific Scala versions, e.g.,
+
+```py
 kind_projector_version = "0.13.2" if scala_major < "2.13" else "0.13.3"
 ```
 
-In order of that, there may be situations that script won't work. To debug that problem and adjust the values of hard-coded variables:
-```
-scala_test_major = "3" if scala_major >= "3.0" else scala_major
-scala_fmt_major = "2.13" if scala_major >= "3.0" else scala_major
+There may be situations in which the script won't work. To debug that problem
+and adjust the values of hard-coded variables:
+
+```py
+scalatest_major = "3" if scala_major >= "3.0" else scala_major
+scalafmt_major = "2.13" if scala_major >= "3.0" else scala_major
 kind_projector_version = "0.13.2" if scala_major < "2.13" else "0.13.3"
-f"org.scalameta:scalafmt-core_{scala_fmt_major}:{"2.7.5" if scala_major == "2.11" else scala_fmt_version}"
+scalafmt_version = "2.7.5" if scala_major == "2.11" else SCALAFMT_VERSION
 ```
-there is an option to print the output of these two subprocesses:
 
-`output = subprocess.run(f'cs fetch {artifact}', capture_output=True, text=True, shell=True).stdout.splitlines()` <br>
+there is an option to print the output of these two subprocesses:
 
+```py
+    command = f'cs resolve {' '.join(root_artifacts)}'
+    output = subprocess.run(
+        command, capture_output=True, text=True, shell=True
+    ).stdout.splitlines()
 ```
-  command = f'cs resolve {' '.join(root_artifacts)}'
-  output = subprocess.run(command, capture_output=True, text=True, shell=True).stdout.splitlines()
-```
 
-### Requirements
-Installed [Coursier](https://get-coursier.io/) and [Python 3](https://www.python.org/downloads/)
+## Requirements
+
+Install [Coursier](https://get-coursier.io/) and
+[Python 3](https://www.python.org/downloads/) before running the script.