Merge pull request #18 from mozilla/build-img

Build and Push to GCR

Author: bsieber-mozilla

.github/CODEOWNERS

@@ -1 +1 @@
-**/*.py @mozilla/jbi-reviewers
+* @mozilla/jbi-reviewers

.github/workflows/build-image.yaml

@@ -1,6 +1,6 @@
 name: Build Docker image
 
-on: [ push, pull_request ]
+on: pull_request
 
 jobs:
   prepare:
@@ -24,11 +24,13 @@ jobs:
           fi
         env:
           version_pattern: "tags\\/v[0-9]+\\.[0-9]+\\.[0-9]+"
-
-
   build-image:
     runs-on: ubuntu-latest
     needs: prepare
+    environment:
+        name: dev
+    outputs:
+      BUILD_TAG: ${{ steps.build-push.outputs.build-tag }}
 
     steps:
       - name: Echo tag
@@ -38,41 +40,55 @@ jobs:
         run: |
           echo "Building an image with the following tag:"
           echo $IMAGE_TAG
+
       - name: Checkout
         uses: actions/checkout@v2
 
-#      - name: Configure AWS Credentials
-#        uses: aws-actions/configure-aws-credentials@v1
-#        id: configure-aws-creds
-#        env:
-#          AWS_REGION: us-west-2
-#        with:
-#          aws-access-key-id: ${{ secrets.ECR_AWS_ACCESS_KEY_ID }}
-#          aws-secret-access-key: ${{ secrets.ECR_AWS_SECRET_ACCESS_KEY }}
-#          aws-region: ${{ env.AWS_REGION }}
-#
-#      - name: Login to Amazon ECR
-#        id: login-ecr
-#        uses: aws-actions/amazon-ecr-login@v1
-#
-#      - name: Build and push to ECR
-#        id: build-push
-#        env:
-#          ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
-#          ECR_REPOSITORY: jira-bugzilla-integration
-#          IMAGE_TAG: ${{ needs.prepare.outputs.FULL_IMAGE_TAG }}
-#        run: |
-#          printf '{\n    "commit": "%s",\n    "version": "%s",\n    "image_tag": "%s",\n    "source": "%s",\n    "build": "%s"\n}\n' \
-#            "$GITHUB_SHA" \
-#            "$GITHUB_REF" \
-#            "$IMAGE_TAG" \
-#            "$GITHUB_SERVER_URL/$GITHUB_REPOSITORY" \
-#            "$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID" > ./version.json
-#          docker build --file infra/Dockerfile -t $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG .
-#          docker image tag $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG $ECR_REGISTRY/$ECR_REPOSITORY:latest
-#          docker push $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG
-#          docker push $ECR_REGISTRY/$ECR_REPOSITORY:latest
-#      - name: Logut of Amazon ECR
-#        if: always()
-#        run: |
-#          docker logout ${{ steps.login-ecr.outputs.registry }}
+      - name: Login to GCR
+        uses: docker/login-action@v1
+        with:
+          registry: gcr.io
+          username: _json_key
+          password: ${{ secrets.GCP_CREDENTIALS }}
+
+      - name: Build and push to GCR
+        id: build-push
+        env:
+          GCR_REGISTRY: gcr.io/${{ secrets.GCP_PROJECT_ID }}/${{ secrets.GCP_APP_NAME }}/${{ secrets.GCP_GCR_REPO }}
+          IMAGE_TAG: ${{ needs.prepare.outputs.FULL_IMAGE_TAG }}
+        run: |
+          printf '{\n    "commit": "%s",\n    "version": "%s",\n    "image_tag": "%s",\n    "source": "%s",\n    "build": "%s"\n}\n' \
+            "$GITHUB_SHA" \
+            "$GITHUB_REF" \
+            "$IMAGE_TAG" \
+            "$GITHUB_SERVER_URL/$GITHUB_REPOSITORY" \
+            "$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID" > ./version.json
+          docker build --file infra/Dockerfile -t $GCR_REGISTRY:$IMAGE_TAG .
+          docker image tag $GCR_REGISTRY:$IMAGE_TAG $GCR_REGISTRY:latest
+          docker push $GCR_REGISTRY:$IMAGE_TAG
+          docker push $GCR_REGISTRY:latest
+          echo "::set-output name=build-tag::$IMAGE_TAG"
+          echo "::debug::Set the build-tag output as $IMAGE_TAG"
+
+  deploy-image:
+    runs-on: ubuntu-latest
+    needs: build-image
+    environment:
+      name: dev
+
+    steps:
+      - id: auth
+        uses: google-github-actions/auth@v0
+        with:
+          credentials_json: ${{ secrets.GCP_CREDENTIALS }}
+
+      - name: Deploy to Cloud Run
+        uses: google-github-actions/deploy-cloudrun@v0
+        with:
+          service: ${{ secrets.GCP_APP_NAME }}
+          image: gcr.io/${{ secrets.GCP_PROJECT_ID }}/${{ secrets.GCP_APP_NAME }}/${{ secrets.GCP_GCR_REPO }}:${{ needs.build-image.outputs.BUILD_TAG }}
+          region: ${{ secrets.GCP_REGION }}
+          secrets: |
+            JIRA_PASSWORD=JIRA_PASSWORD:latest
+            JIRA_USERNAME=JIRA_USERNAME:latest
+            BUGZILLA_API_KEY=BUGZILLA_API_KEY:latest

README.md

@@ -1,12 +1,58 @@
+![build badge](https://github.com/mozilla/jira-bugzilla-integration/actions/workflows/build-image.yaml/badge.svg)
+![test badge](https://github.com/mozilla/jira-bugzilla-integration/actions/workflows/test-build.yaml/badge.svg)
+
 # Jira Bugzilla Integration (JBI)
-System to sync bugs and issues
+System to sync Bugzilla bugs to Jira issues.
+
+### Caveats
+- The system accepts webhook events from Bugzilla
+- Bugs' whiteboard tags are used to determine if they should be synchronized or ignored
+- The events are transformed into Jira issues
+- The system sets the `see_also` field of the Bugzilla bug with the URL to the Jira issue
+
+## Action Configuration
+The system reads the action configuration from a YAML file, one per environment. Each entry controls the synchronization between Bugzilla tickets with Jira issues.
+
+
+Below is a full example of an action configuration:
+```yaml
+    action: src.jbi.whiteboard_actions.default
+    contact: [[email protected]]
+    description: example configuration
+    enabled: true
+    parameters:
+      jira_project_key: EXMPL
+      whiteboard_tag: example
+```
+
+A bit more about the different fields...
+- `action` (optional)
+    - string
+    - default: [src.jbi.whiteboard_actions.default](src/jbi/whiteboard_actions/default.py)
+    - The specified Python module must be available in the `PYTHONPATH`
+- `contact`
+    - list of strings
+    - If an issue arises with the workflow, communication will be established with these contacts
+    - Please enter the contact information for one or more stakeholders
+- `description`
+    - string
+    - Please enter a description; for example, team name or project use-case.
+- `enabled` (optional)
+    - bool [true, false]
+    - default: false
+    - If false, matching events will not be synchronized
+- `parameters` (optional)
+    - dict
+    - default: {}
+    - The parameters will be validated to ensure the selected action accepts the specified values
+    - The [default action](src/jbi/whiteboard_actions/default.py) expects both the `whiteboard_tag` and `jira_project_key` fields
+
+
+
+[View 'dev'  configurations here.](config/config.dev.yaml)
 
-## Self-Service
+[View 'prod' configurations here.](config/config.prod.yaml)
 
-If you're interested in using the default action;
-the process is simple to enabling a new downstream
-project. [...read more here.](src/jbi/whiteboard_tags/README.md)
 
-If you're looking for a unique capability for your
-team's data flow; you can add your own python methods
-and functionality. [...read more here.](src/jbi/whiteboard_actions/README.md)
+### Custom Actions
+If you're looking for a unique capability for your team's data flow, you can add your own python methods and functionality[...read more here.](src/jbi/whiteboard_actions/README.md)