Add protobuf zip generation for releases (opensearch-project#139)

* Add protobuf zip generation for releases

Signed-off-by: Karen Xu <karenxyr@gmail.com>

Author: karenyrx

.github/workflows/release-drafter.yml

@@ -2,8 +2,9 @@ name: Release drafter
 
 # Push events to every tag not containing "/"
 #
-# Publish the commons JAR to Maven Local, and create 'artifacts.tar.gz'
-# using build dir and adding the contents of repository
+# Publish the Java JAR to Maven Local, and create release artifacts:
+# - opensearch-protobufs-java.tar.gz (Java/Maven artifacts)
+# - opensearch-protobufs-{version}.zip (Raw proto files)
 #
 on:
   push:
@@ -39,11 +40,17 @@ jobs:
       - name: Build with Gradle
         run: |
           ./tools/java/package_proto_jar.sh -c true -s false
-          ./gradlew --no-daemon -Dbuild.snapshot=false publishCreatePublicationToLocalRepoRepository && tar -C build -cvf artifacts.tar.gz repository
+          ./gradlew --no-daemon -Dbuild.snapshot=false publishCreatePublicationToLocalRepoRepository
+          tar -C build -cvf "opensearch-protobufs-java.tar.gz" repository
+
+      - name: Create protobuf zip
+        run: ./tools/package_proto_zip.sh
+
       - name: Draft a release
         uses: softprops/action-gh-release@v1
         with:
           draft: true
           generate_release_notes: true
           files: |
-            artifacts.tar.gz
+            opensearch-protobufs-java.tar.gz
+            opensearch-protobufs-*.zip

CHANGELOG.md

@@ -5,6 +5,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ## [Unreleased]
 ### Added
 - Add Go protobuf generation support ([#131](https://github.com/opensearch-project/opensearch-protobufs/pull/131))
+- Add protobuf zip generation for releases ([#139](https://github.com/opensearch-project/opensearch-protobufs/pull/139))
 
 ### Removed
 

README.md

@@ -45,6 +45,26 @@ docker build --target package-bazel-go .
 docker build --target test-bazel-go .
 ```
 
+## Releases
+
+Each OpenSearch Protobufs release includes:
+
+- **Java Archive**: `opensearch-protobufs-java.tar.gz` - Maven-compatible JAR files for Java/Gradle projects
+- **Protobuf ZIP**: `opensearch-protobufs-{version}.zip` - Raw `.proto` files for generating client libraries in any language
+
+Download the latest release from the [GitHub Releases page](https://github.com/opensearch-project/opensearch-protobufs/releases).
+
+### Using Raw Proto Files
+
+1. Download `opensearch-protobufs-{version}.zip` from releases to get just the `.proto` files:
+
+2. Extract the zip:
+```bash
+unzip opensearch-protobufs-{version}.zip
+cd opensearch-protobufs-{version}
+```
+3. Follow latest documentation on https://protobuf.dev/reference/ to generate client libraries for different languages.
+
 ## Generated Code Usage
 
 ### Go

jenkins/release.jenkinsFile

@@ -8,6 +8,7 @@ standardReleasePipelineWithGenericTrigger(
     tokenIdCredential: 'jenkins-opensearch-protobufs-generic-webhook-token',
     causeString: 'A tag was cut on opensearch-project/opensearch-protobufs repository causing this workflow to run',
     downloadReleaseAsset: true,
+    downloadReleaseAssetName: 'opensearch-protobufs-java.tar.gz',
     publishRelease: true) {
         publishToMaven(
             signingArtifactsPath: "$WORKSPACE/repository/",

tools/package_proto_zip.sh

@@ -0,0 +1,54 @@
+#!/bin/bash
+# Script to package proto files into a zip for release
+
+set -e
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+ROOT_DIR="$(cd "${SCRIPT_DIR}/.." && pwd)"
+
+# Get version from version.properties
+VERSION=$(grep 'version=' "${ROOT_DIR}/version.properties" | cut -d'=' -f2)
+ZIP_NAME="opensearch-protobufs-${VERSION}.zip"
+
+echo "Creating protobuf zip: ${ZIP_NAME}"
+
+# Create temporary directory for organization
+TEMP_DIR=$(mktemp -d)
+PROTO_DIR="${TEMP_DIR}/opensearch-protobufs-${VERSION}"
+
+# Copy proto files with structure
+mkdir -p "${PROTO_DIR}/schemas"
+mkdir -p "${PROTO_DIR}/services"
+
+cp "${ROOT_DIR}/protos/schemas"/*.proto "${PROTO_DIR}/schemas/"
+cp "${ROOT_DIR}/protos/services"/*.proto "${PROTO_DIR}/services/"
+
+# Add a README for the zip
+cat > "${PROTO_DIR}/README.txt" << EOF
+OpenSearch Protocol Buffers v${VERSION}
+
+This archive contains the Protocol Buffer (.proto) files for OpenSearch gRPC APIs.
+
+Structure:
+- schemas/     - Core data structure definitions
+- services/    - gRPC service definitions
+
+Usage:
+Use these .proto files with your preferred Protocol Buffer compiler (protoc)
+to generate client libraries for your programming language.
+
+For more information, visit:
+https://github.com/opensearch-project/opensearch-protobufs
+
+EOF
+
+# Create the zip
+cd "${TEMP_DIR}"
+zip -r "${ROOT_DIR}/${ZIP_NAME}" "opensearch-protobufs-${VERSION}/"
+
+# Cleanup
+rm -rf "${TEMP_DIR}"
+
+echo "Successfully created: ${ZIP_NAME}"
+echo "Contents:"
+unzip -l "${ROOT_DIR}/${ZIP_NAME}"