You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spark.apache.org by do...@apache.org on 2024/08/14 16:48:16 UTC
(spark-kubernetes-operator) branch main updated: [SPARK-49236] Update `README.md` with `build/test/CI` info
This is an automated email from the ASF dual-hosted git repository.
dongjoon pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/spark-kubernetes-operator.git
The following commit(s) were added to refs/heads/main by this push:
new 840f369 [SPARK-49236] Update `README.md` with `build/test/CI` info
840f369 is described below
commit 840f36914dcd6c9c92a452c214d520397be81cb8
Author: Dongjoon Hyun <do...@apache.org>
AuthorDate: Wed Aug 14 09:48:08 2024 -0700
[SPARK-49236] Update `README.md` with `build/test/CI` info
### What changes were proposed in this pull request?
This PR aims to update `README.md` with `build/test/CI status` information.
### Why are the changes needed?
To help new comers. You can see the result in the PR branch like the following.
- https://github.com/dongjoon-hyun/spark-kubernetes-operator/tree/SPARK-49236
<img width="896" alt="Screenshot 2024-08-14 at 09 30 10" src="https://github.com/user-attachments/assets/b398e703-5cdf-4d58-a31c-93e3f991f75e">
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
Manual review.
### Was this patch authored or co-authored using generative AI tooling?
No.
Closes #45 from dongjoon-hyun/SPARK-49236.
Authored-by: Dongjoon Hyun <do...@apache.org>
Signed-off-by: Dongjoon Hyun <do...@apache.org>
---
README.md | 28 +++++++++++++++++++++++++++-
1 file changed, 27 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 52a85ba..18bf91c 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,27 @@
-# spark-kubernetes-operator
+# Apache Spark K8s Operator
+
+Apache Spark K8s Operator is a subproject of [Apache Spark](https://spark.apache.org/) and
+aims to extend K8s resource manager to manage Apache Spark applications via
+[Operator Pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/).
+
+[](https://github.com/apache/spark-kubernetes-operator/actions/workflows/build_and_test.yml)
+
+## Building Spark K8s Operator
+
+Spark K8s Operator is built using Gradle.
+To build, run:
+
+```bash
+./gradlew build -x test
+```
+
+## Running Tests
+
+```bash
+./gradlew build
+```
+
+## Contributing
+
+Please review the [Contribution to Spark guide](https://spark.apache.org/contributing.html)
+for information on how to get started contributing to the project.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org