Publish to central (#179)

* add ci release plugin to build

* update package name

* update readme, add contribution guide and fix formatting

Author: chitralverma

.github/workflows/release.yml

@@ -59,7 +59,7 @@ jobs:
         include:
           - os: ubuntu-latest
             arch: aarch64-unknown-linux-gnu
-            packages: "sudo apt update && sudo apt-get install gcc-aarch64-linux-gnu"
+            packages: "sudo apt-get update && sudo apt-get install gcc-aarch64-linux-gnu"
 
           - os: ubuntu-latest
             arch: x86_64-unknown-linux-gnu
@@ -190,7 +190,12 @@ jobs:
         working-directory: ${{env.NATIVE_LIB_LOCATION}}
 
       - name: Publish Artifacts
-        run: sbt +aetherDeploy
+        env:
+          PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }}
+          PGP_SECRET: ${{ secrets.PGP_SECRET }}
+          SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
+          SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
+        run: sbt ci-release
 
       - name: Publish API Docs
         run: |

CONTRIBUTING.md

@@ -0,0 +1,115 @@
+# Contributing to scala-polars
+
+Thanks for your interest in contributing to `scala-polars`! 🚀
+
+Whether you're fixing a bug, writing tests/ documentation, or building features, we welcome your help.
+
+---
+
+## 🛠️ Project Structure
+
+- `core/`: The main Scala and Java API used by end users
+- `native/`: A Rust module compiled into a shared library via Cargo and linked via JNI
+- `examples/`: Sample applications in both Scala and Java
+
+---
+
+## 💧 Build Prerequisites
+
+Ensure the following are installed:
+
+- Java 8+ (JDK)
+- [Rust](https://www.rust-lang.org/tools/install)
+- [sbt](https://www.scala-sbt.org/)
+
+---
+
+## Compilation Process
+
+`sbt` is the primary build tool for this project, and all the required interlinking has been done in such a way that
+your
+IntelliJ IDE or an external build works in the same way. This means that whether you are in development mode or want to
+build to distribute, the process of the build remains the same and is more or less abstracted.
+
+The build process that sbt triggers involves the following steps
+
+- Compile the rust code present in the `native` module to a binary.
+- Compile the scala and java (if any) facade code.
+- Copy the built rust binary to the classpath of scala code during its build at a fixed location.
+
+All the above steps happen automatically when you run an sbt build job that triggers `compile` phase. Other than
+this, during the package phase, the scala, java code and the built rust binary are added to the built jar(s). To keep
+everything monolithic, the `native` module is not packaged as a jar, only `core` module is.
+
+The above process might look complicated, and it actually is 😂, but since all the internally sbt wiring is already in
+place, the user facing process is fairly straight-forward. This can be done by going through the following steps in
+sequence firstly ensure JDK 8+, sbt and the latest rust
+compiler are installed, then follow the commands below as per the need.
+
+---
+
+## 🏗 Build Commands
+
+### Full project (Rust + Scala/Java)
+
+```bash
+sbt compile
+```
+
+### Native Rust library only
+
+```bash
+sbt generateNativeLibrary
+```
+
+### Locally publish
+
+```bash
+sbt publishLocal
+```
+
+### Fat JAR
+
+```bash
+sbt assembly
+```
+
+---
+
+## 🔍 Testing
+
+Run unit tests via:
+
+```bash
+sbt test
+```
+
+---
+
+## ✍️ Conventions
+
+- Follow idiomatic Scala where possible.
+- Keep Rust and Scala types in sync when modifying the native interface.
+- Test across multiple Scala versions (`2.12`, `2.13`, `3.x`) if making public API changes.
+- Document any native API changes clearly.
+
+---
+
+## 📤 Publishing Snapshots
+
+If you're a maintainer:
+
+```bash
+# Publish to Sonatype snapshots
+sbt +publish
+```
+
+---
+
+## 📬 Getting Help
+
+- [Open an issue](https://github.com/chitralverma/scala-polars/issues)
+- Join the [Polars Discord](https://discord.gg/4UfP5cfBE7)
+
+We appreciate every contribution ❤️
+