Skip to content

A Q&A platform software for teams at any scales. Whether it's a community forum, help center, or knowledge management platform, you can always count on Apache Answer.

Integrate Uffizzi

Shruti Chaturvedi7b7d5f2f4966
diff --git a/.github/workflows/uffizzi-build.yml b/.github/workflows/uffizzi-build.yml
new file mode 100644
index 00000000..8786952c
--- /dev/null
+++ b/.github/workflows/uffizzi-build.yml
@@ -0,0 +1,98 @@
+name: Build PR Image
+on:
+ pull_request:
+ types: [opened, synchronize, reopened, closed]
+
+jobs:
+ build-answer:
+ name: Build and push `Answer`
+ runs-on: ubuntu-latest
+ outputs:
+ tags: ${{ steps.meta.outputs.tags }}
+ if: ${{ github.event.action != 'closed' }}
+ steps:
+ - name: Checkout git repo
+ uses: actions/checkout@v3
+
+ - name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v2
+
+ - name: Generate UUID image name
+ id: uuid
+ run: echo "UUID_WORKER=$(uuidgen)" >> $GITHUB_ENV
+
+ - name: Docker metadata
+ id: meta
+ uses: docker/metadata-action@v4
+ with:
+ images: registry.uffizzi.com/${{ env.UUID_WORKER }}
+ tags: |
+ type=raw,value=60d
+
+ - name: Build and Push Image to registry.uffizzi.com - Uffizzi's ephemeral Registry
+ uses: docker/build-push-action@v3
+ with:
+ context: .
+ file: ./Dockerfile
+ tags: ${{ steps.meta.outputs.tags }}
+ labels: ${{ steps.meta.outputs.labels }}
+ push: true
+ cache-from: type=gha
+ cache-to: type=gha, mode=max
+
+ render-compose-file:
+ name: Render Docker Compose File
+ # Pass output of this workflow to another triggered by `workflow_run` event.
+ runs-on: ubuntu-latest
+ needs:
+ - build-answer
+ outputs:
+ compose-file-cache-key: ${{ steps.hash.outputs.hash }}
+ steps:
+ - name: Checkout git repo
+ uses: actions/checkout@v3
+ - name: Render Compose File
+ run: |
+ ANSWER_IMAGE=${{ needs.build-answer.outputs.tags }}
+ export ANSWER_IMAGE
+ export UFFIZZI_URL=\$UFFIZZI_URL
+ # Render simple template from environment variables.
+ envsubst < docker-compose.uffizzi.yml > docker-compose.rendered.yml
+ cat docker-compose.rendered.yml
+ - name: Upload Rendered Compose File as Artifact
+ uses: actions/upload-artifact@v3
+ with:
+ name: preview-spec
+ path: docker-compose.rendered.yml
+ retention-days: 2
+ - name: Serialize PR Event to File
+ run: |
+ cat << EOF > event.json
+ ${{ toJSON(github.event) }}
+
+ EOF
+ - name: Upload PR Event as Artifact
+ uses: actions/upload-artifact@v3
+ with:
+ name: preview-spec
+ path: event.json
+ retention-days: 2
+
+ delete-preview:
+ name: Call for Preview Deletion
+ runs-on: ubuntu-latest
+ if: ${{ github.event.action == 'closed' }}
+ steps:
+ # If this PR is closing, we will not render a compose file nor pass it to the next workflow.
+ - name: Serialize PR Event to File
+ run: |
+ cat << EOF > event.json
+ ${{ toJSON(github.event) }}
+
+ EOF
+ - name: Upload PR Event as Artifact
+ uses: actions/upload-artifact@v3
+ with:
+ name: preview-spec
+ path: event.json
+ retention-days: 2
diff --git a/.github/workflows/uffizzi-preview.yml b/.github/workflows/uffizzi-preview.yml
new file mode 100644
index 00000000..f7909741
--- /dev/null
+++ b/.github/workflows/uffizzi-preview.yml
@@ -0,0 +1,88 @@
+name: Deploy Uffizzi Preview
+
+on:
+ workflow_run:
+ workflows:
+ - "Build PR Image"
+ types:
+ - completed
+
+
+jobs:
+ cache-compose-file:
+ name: Cache Compose File
+ runs-on: ubuntu-latest
+ if: ${{ github.event.workflow_run.conclusion == 'success' }}
+ outputs:
+ compose-file-cache-key: ${{ env.HASH }}
+ pr-number: ${{ env.PR_NUMBER }}
+ steps:
+ - name: 'Download artifacts'
+ # Fetch output (zip archive) from the workflow run that triggered this workflow.
+ uses: actions/github-script@v6
+ with:
+ script: |
+ let allArtifacts = await github.rest.actions.listWorkflowRunArtifacts({
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ run_id: context.payload.workflow_run.id,
+ });
+ let matchArtifact = allArtifacts.data.artifacts.filter((artifact) => {
+ return artifact.name == "preview-spec"
+ })[0];
+ let download = await github.rest.actions.downloadArtifact({
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ artifact_id: matchArtifact.id,
+ archive_format: 'zip',
+ });
+ let fs = require('fs');
+ fs.writeFileSync(`${process.env.GITHUB_WORKSPACE}/preview-spec.zip`, Buffer.from(download.data));
+
+ - name: 'Unzip artifact'
+ run: unzip preview-spec.zip
+ - name: Read Event into ENV
+ run: |
+ echo 'EVENT_JSON<<EOF' >> $GITHUB_ENV
+ cat event.json >> $GITHUB_ENV
+ echo 'EOF' >> $GITHUB_ENV
+
+ - name: Hash Rendered Compose File
+ id: hash
+ # If the previous workflow was triggered by a PR close event, we will not have a compose file artifact.
+ if: ${{ fromJSON(env.EVENT_JSON).action != 'closed' }}
+ run: echo "HASH=$(md5sum docker-compose.rendered.yml | awk '{ print $1 }')" >> $GITHUB_ENV
+ - name: Cache Rendered Compose File
+ if: ${{ fromJSON(env.EVENT_JSON).action != 'closed' }}
+ uses: actions/cache@v3
+ with:
+ path: docker-compose.rendered.yml
+ key: ${{ env.HASH }}
+
+ - name: Read PR Number From Event Object
+ id: pr
+ run: echo "PR_NUMBER=${{ fromJSON(env.EVENT_JSON).number }}" >> $GITHUB_ENV
+ - name: DEBUG - Print Job Outputs
+ if: ${{ runner.debug }}
+ run: |
+ echo "PR number: ${{ env.PR_NUMBER }}"
+ echo "Compose file hash: ${{ env.HASH }}"
+ cat event.json
+
+ deploy-uffizzi-preview:
+ name: Use Remote Workflow to Preview on Uffizzi
+ needs:
+ - cache-compose-file
+ if: ${{ github.event.workflow_run.conclusion == 'success' }}
+ uses: UffizziCloud/preview-action/.github/workflows/reusable.yaml@v2
+ with:
+ # If this workflow was triggered by a PR close event, cache-key will be an empty string
+ # and this reusable workflow will delete the preview deployment.
+ compose-file-cache-key: ${{ needs.cache-compose-file.outputs.compose-file-cache-key }}
+ compose-file-cache-path: docker-compose.rendered.yml
+ server: https://app.uffizzi.com
+ pr-number: ${{ needs.cache-compose-file.outputs.pr-number }}
+ permissions:
+ contents: read
+ pull-requests: write
+ id-token: write
diff --git a/docker-compose.uffizzi.yml b/docker-compose.uffizzi.yml
new file mode 100644
index 00000000..f26d2bdc
--- /dev/null
+++ b/docker-compose.uffizzi.yml
@@ -0,0 +1,36 @@
+version: "3"
+
+# uffizzi integration
+x-uffizzi:
+ ingress:
+ service: answer
+ port: 80
+
+services:
+
+ answer:
+ image: "${ANSWER_IMAGE}"
+ volumes:
+ - answer-data:/data
+ deploy:
+ resources:
+ limits:
+ memory: 4000M
+
+ mysql:
+ image: mysql:latest
+ environment:
+ - MYSQL_DATABASE=answer
+ - MYSQL_ROOT_PASSWORD=password
+ - MYSQL_USER=mysql
+ - MYSQL_PASSWORD=mysql
+ volumes:
+ - sql_data:/var/lib/mysql
+ deploy:
+ resources:
+ limits:
+ memory: 500M
+
+volumes:
+ answer-data:
+ sql_data: