Publish .g4 files to maven#3652
Merged
dai-chen merged 27 commits intoopensearch-project:poc/commit-metadatafrom May 21, 2025
Merged
Publish .g4 files to maven#3652dai-chen merged 27 commits intoopensearch-project:poc/commit-metadatafrom
dai-chen merged 27 commits intoopensearch-project:poc/commit-metadatafrom
Conversation
…ect-query Signed-off-by: Kai Huang <ahkcs@amazon.com>
Signed-off-by: Kai Huang <ahkcs@amazon.com>
Signed-off-by: Kai Huang <ahkcs@amazon.com>
Signed-off-by: Kai Huang <ahkcs@amazon.com>
Signed-off-by: Kai Huang <ahkcs@amazon.com>
Signed-off-by: Kai Huang <ahkcs@amazon.com>
Signed-off-by: Kai Huang <ahkcs@amazon.com>
Signed-off-by: Kai Huang <ahkcs@amazon.com>
Signed-off-by: Kai Huang <105710027+ahkcs@users.noreply.github.com>
Signed-off-by: Kai Huang <ahkcs@amazon.com>
Signed-off-by: Kai Huang <ahkcs@amazon.com>
Signed-off-by: Kai Huang <ahkcs@amazon.com>
…nto poc/commit-metadata
…h zip file containing all .g4 files to maven under /opensearch-language-grammar Signed-off-by: Kai Huang <ahkcs@amazon.com>
Signed-off-by: Kai Huang <ahkcs@amazon.com>
Signed-off-by: Kai Huang <105710027+ahkcs@users.noreply.github.com>
…commit-metadata # Conflicts: # .github/workflows/maven-publish.yml
Signed-off-by: Kai Huang <ahkcs@amazon.com>
…nto poc/commit-metadata
ahkcs
requested review from
GumpacG,
MaxKsyunz,
Swiddis,
YANG-DB,
Yury-Fridlyand,
acarbonetto,
anirudha,
dai-chen,
forestmvey,
joshuali925,
mengweieric,
penghuo,
seankao-az and
ykmr1224
as code owners
dai-chen
merged commit e6f46e4
into
opensearch-project:poc/commit-metadata
23 of 24 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a GitHub Actions workflow that automatically packages and publishes ANTLR grammar files (.g4) from the unified-grammar/src/main/antlr4 directory to the Maven snapshot repository.
Implementation Details
The workflow:
Packages all ANTLR .g4 grammar files into a single ZIP file
Creates the necessary directory structure in the Maven repository
Publishes the ZIP to https://aws.oss.sonatype.org/content/repositories/snapshots/org/opensearch/opensearch-language-grammar-poc
Generates appropriate Maven metadata including POM files and checksum files
Tags the published artifacts with the source commit ID for traceability
Purpose
This allows grammar files to be versioned and distributed separately from the main codebase, enabling:
Grammar reuse across different projects
Independent versioning of grammar definitions
Easier integration of our grammar definitions in third-party tools
Technical Notes
The workflow runs on push to main branch and can also be triggered manually
Uses AWS Secrets Manager to securely retrieve Maven repository credentials
Creates a version 1.0.0-SNAPSHOT by default (configurable in the workflow)
Requires the AWS IAM role specified in PUBLISH_SNAPSHOTS_ROLE secret
Testing
The workflow was tested by manually triggering it and verifying the artifacts were correctly published to the Maven repository at the specified path.