-
Notifications
You must be signed in to change notification settings - Fork 0
Add GitHub Actions workflow to build and deploy plugin to OMCSI #85
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,120 @@ | ||||||||||||||||||||||||
| # Workflow to automatically build the Mailboxes plugin JAR and deploy it | ||||||||||||||||||||||||
| # to a running omcsi (open-mc-server-infrastructure) instance. | ||||||||||||||||||||||||
| # | ||||||||||||||||||||||||
| # ─── Setup ─────────────────────────────────────────────────────────────────── | ||||||||||||||||||||||||
| # Required GitHub repository secrets: | ||||||||||||||||||||||||
| # OMCSI_DEPLOY_URL – Base URL of your omcsi instance, | ||||||||||||||||||||||||
| # e.g. https://mc.example.com:8092 | ||||||||||||||||||||||||
| # OMCSI_DEPLOY_TOKEN – The value set as DEPLOY_AUTH_TOKEN in your omcsi .env | ||||||||||||||||||||||||
| # | ||||||||||||||||||||||||
| # Required GitHub repository variables: | ||||||||||||||||||||||||
| # PLUGIN_JAR_NAME – Filename of the plugin JAR on the server, | ||||||||||||||||||||||||
| # e.g. Mailboxes.jar (the file that will be replaced) | ||||||||||||||||||||||||
| # | ||||||||||||||||||||||||
| # Optional GitHub repository variables: | ||||||||||||||||||||||||
| # DEPLOY_BRANCH – Branch that triggers a deployment (default: main) | ||||||||||||||||||||||||
| # ───────────────────────────────────────────────────────────────────────────── | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| name: Deploy Plugin to omcsi | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| # Trigger on pushes (branch-gated via the job condition) and on manual runs | ||||||||||||||||||||||||
| # via the "Run workflow" button in the Actions tab. | ||||||||||||||||||||||||
| # Note: ${{ vars.* }} expressions are NOT evaluated inside the `on:` event | ||||||||||||||||||||||||
| # filter – only inside job steps and conditions. | ||||||||||||||||||||||||
| on: | ||||||||||||||||||||||||
| push: | ||||||||||||||||||||||||
| workflow_dispatch: | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| jobs: | ||||||||||||||||||||||||
| build-and-deploy: | ||||||||||||||||||||||||
| name: Build and Deploy Plugin | ||||||||||||||||||||||||
| # Run on manual dispatch (any branch) or when the pushed branch matches | ||||||||||||||||||||||||
| # DEPLOY_BRANCH (default: main). | ||||||||||||||||||||||||
| if: ${{ github.event_name == 'workflow_dispatch' || github.ref_name == (vars.DEPLOY_BRANCH || 'main') }} | ||||||||||||||||||||||||
| runs-on: ubuntu-latest | ||||||||||||||||||||||||
| permissions: | ||||||||||||||||||||||||
| contents: read | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| steps: | ||||||||||||||||||||||||
| - name: Checkout code | ||||||||||||||||||||||||
| uses: actions/checkout@v4 | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| - name: Set up JDK 8 | ||||||||||||||||||||||||
| uses: actions/setup-java@v4 | ||||||||||||||||||||||||
| with: | ||||||||||||||||||||||||
| distribution: temurin | ||||||||||||||||||||||||
| java-version: '8' | ||||||||||||||||||||||||
| cache: maven | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| - name: Build plugin JAR | ||||||||||||||||||||||||
| run: mvn --batch-mode package | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| - name: Locate built JAR | ||||||||||||||||||||||||
| id: locate-jar | ||||||||||||||||||||||||
| run: | | ||||||||||||||||||||||||
| # Use find to reliably locate the shaded JAR, excluding the maven-shade-plugin's | ||||||||||||||||||||||||
| # original (pre-shading) copy and any *-sources / *-javadoc JARs. | ||||||||||||||||||||||||
| JAR_FILE=$(find target -maxdepth 1 -name '*.jar' \ | ||||||||||||||||||||||||
| ! -name 'original-*' \ | ||||||||||||||||||||||||
| ! -name '*-sources.jar' \ | ||||||||||||||||||||||||
| ! -name '*-javadoc.jar' \ | ||||||||||||||||||||||||
| -print -quit) | ||||||||||||||||||||||||
| if [ -z "${JAR_FILE}" ]; then | ||||||||||||||||||||||||
| echo "❌ No JAR found in target/" | ||||||||||||||||||||||||
| exit 1 | ||||||||||||||||||||||||
| fi | ||||||||||||||||||||||||
| echo "jar_file=${JAR_FILE}" >> "$GITHUB_OUTPUT" | ||||||||||||||||||||||||
| echo "✅ Found JAR: ${JAR_FILE}" | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| - name: Deploy plugin to omcsi | ||||||||||||||||||||||||
| env: | ||||||||||||||||||||||||
| DEPLOY_TOKEN: ${{ secrets.OMCSI_DEPLOY_TOKEN }} | ||||||||||||||||||||||||
| DEPLOY_URL: ${{ secrets.OMCSI_DEPLOY_URL }} | ||||||||||||||||||||||||
| JAR_FILE: ${{ steps.locate-jar.outputs.jar_file }} | ||||||||||||||||||||||||
| run: | | ||||||||||||||||||||||||
| PLUGIN_JAR_NAME="${{ vars.PLUGIN_JAR_NAME }}" | ||||||||||||||||||||||||
| if [ -z "${PLUGIN_JAR_NAME}" ]; then | ||||||||||||||||||||||||
| echo "❌ PLUGIN_JAR_NAME variable is not set" | ||||||||||||||||||||||||
| exit 1 | ||||||||||||||||||||||||
| fi | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
|
||||||||||||||||||||||||
| if [ -z "${DEPLOY_URL}" ]; then | |
| echo "❌ OMCSI_DEPLOY_URL secret is not set or is empty" | |
| exit 1 | |
| fi | |
| if [ -z "${DEPLOY_TOKEN}" ]; then | |
| echo "❌ OMCSI_DEPLOY_TOKEN secret is not set or is empty" | |
| exit 1 | |
| fi |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider enabling Maven dependency caching in setup-java (e.g.,
cache: maven). Without it, each run downloads dependencies from scratch, which can significantly slow down CI and increase the chance of transient network failures during builds.