Release 0.2.0, generated from commit eb17149

Author: rohit-drone

.github/workflows/generate.yml

@@ -81,6 +81,9 @@ jobs:
           cp LICENSE release/
           cp .gitignore release/
 
+          # Copy release dockerfile as main dockerfile
+          cp Dockerfile.release release/Dockerfile
+
           # Add all gitignore except dist folder
           head -n -4 .gitignore > release/.gitignore
 

.github/workflows/release.yml

@@ -6,7 +6,7 @@ on:
       - 'releases/*'
 
 jobs:
-  release:
+  docker:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -32,7 +32,90 @@ jobs:
               echo "create_release=yes" >> $GITHUB_ENV
           fi
 
-      - name: Release
+      - name: Docker meta
+        if: ${{ env.create_release == 'yes' }}
+        id: meta
+        uses: docker/metadata-action@v3
+        with:
+          # list of Docker images to use as base name for tags
+          images: |
+            boringdownload/jira-integration
+            ghcr.io/rohit-gohri/jira-ci-cd-integration
+            registry.gitlab.com/rohit-gohri/jira-ci-cd-integration
+          # generate Docker tags based on the following events/attributes
+          tags: |
+            type=ref,event=branch
+            ype=semver,pattern={{version}},value=v${{ env.package_version }}
+            ype=semver,pattern=v{{major}},value=v${{ env.package_version }}
+            type=sha
+
+      - name: Set up QEMU
+        if: ${{ env.create_release == 'yes' }}
+        uses: docker/setup-qemu-action@v1
+      - name: Set up Docker Buildx
+        if: ${{ env.create_release == 'yes' }}
+        uses: docker/setup-buildx-action@v1
+
+      - name: 🛂 Log in to Docker Hub
+        if: ${{ env.create_release == 'yes' }}
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_TOKEN }}
+
+      - name: 🛂 Log in to the Github Container registry
+        if: ${{ env.create_release == 'yes' }}
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: 🛂 Log in to the Gitlab Container registry
+        if: ${{ env.create_release == 'yes' }}
+        uses: docker/login-action@v1
+        with:
+          registry: registry.gitlab.com
+          username: ${{ secrets.GITLAB_USERNAME }}
+          password: ${{ secrets.GITLAB_TOKEN }}
+
+      - name: 🔨🚀 Build and push
+        if: ${{ env.create_release == 'yes' }}
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+  action:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Check if tag already exists
+        run: |
+          # Get version from package.json (head is needed because this also returns "version" npm script line)
+          sed -n '/version/s/,*\r*$//p' package.json | cut -d ':' -f2,3 | sed -e 's/^ "//' -e 's/"$//' | head -n 1 > app_version.tmp
+          cat app_version.tmp | cut -d. -f1 > major_version.tmp
+
+          export VERSION_TAG="v$(cat app_version.tmp)"
+          echo "package_version=$(cat app_version.tmp)" >> $GITHUB_ENV
+          echo "major_version=$(cat major_version.tmp)" >> $GITHUB_ENV
+
+          # Check if tag already exists
+          if [ $(git tag -l "$VERSION_TAG") ]; then
+              echo "Tag already exists, please increment version to create release"
+              echo "create_release=no" >> $GITHUB_ENV
+          else
+              echo "create_release=yes" >> $GITHUB_ENV
+          fi
+
+      - name: 🚀 Release
         uses: softprops/action-gh-release@master
         if: ${{ env.create_release == 'yes' }}
         with:
@@ -41,7 +124,7 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Tag Major Version
+      - name: 🚀 Tag Major Version
         if: ${{ env.create_release == 'yes' }}
         run: |
           git config user.name github-actions[bot]

.github/workflows/test-release.yml

@@ -6,7 +6,7 @@ on:
       - 'releases/*'
 
 jobs:
-  build: # make sure build/ci work properly
+  build:
     runs-on: ubuntu-latest
     steps:
       - name: Jira Development Integration
@@ -20,3 +20,19 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
           client_id: ${{ secrets.JIRA_CLIENT_ID }}
           client_secret: ${{ secrets.JIRA_CLIENT_SECRET }}
+
+  # TODO: Fix this
+  # deployment:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - name: Jira Development Integration
+  #       uses: rohit-gohri/jira-ci-cd-integration@v0
+  #       env:
+  #         JIRA_DEFAULT_TEST_ISSUE: 'JCI-7'
+  #       with:
+  #         event_type: deployment
+  #         state: ${{ job.status }}
+  #         jira_instance: boringdownload
+  #         token: ${{ secrets.GITHUB_TOKEN }}
+  #         client_id: ${{ secrets.JIRA_CLIENT_ID }}
+  #         client_secret: ${{ secrets.JIRA_CLIENT_SECRET }}

.github/workflows/test.yml

@@ -34,8 +34,14 @@ jobs:
       - name: 📦 Install dependencies
         run: npm ci
 
-      - name: 🔨 Build Project
-        run: npm run package
+      - name: Checks
+        run: |
+          npm run lint
+          npm run build
+          npm run test
+
+      - name: 🔨 Package Action
+        run: npm run package:action
 
       - name: Test Action
         uses: ./

Dockerfile

@@ -0,0 +1,8 @@
+FROM node:12-alpine
+
+WORKDIR /usr/jira-ci-cd-integration
+
+# Bundle app source
+COPY . .
+
+CMD ["node", "dist/docker/index.js"]

README.md

@@ -1,19 +1,16 @@
-<p align="center">
-  
-  [![Github Release](https://img.shields.io/github/v/release/rohit-gohri/jira-ci-cd-integration?style=flat-square)](https://github.com/rohit-gohri/jira-ci-cd-integration/releases)
-  
-  <a href="https://github.com/rohit-gohri/jira-ci-cd-integration/actions"><img alt="action status" src="https://github.com/rohit-gohri/jira-ci-cd-integration/workflows/build-test/badge.svg"></a>
+[![Github Release](https://img.shields.io/github/v/release/rohit-gohri/jira-ci-cd-integration?style=flat)](https://github.com/rohit-gohri/jira-ci-cd-integration/releases)
+[![Docker Release](https://img.shields.io/docker/v/boringdownload/jira-integration)](https://hub.docker.com/repository/docker/boringdownload/jira-integration)
+<a href="https://github.com/rohit-gohri/jira-ci-cd-integration/actions"><img alt="action status" src="https://github.com/rohit-gohri/jira-ci-cd-integration/workflows/build-test/badge.svg"></a>
+<a href="https://github.com/rohit-gohri/jira-ci-cd-integration/actions"><img alt="action status" src="https://github.com/rohit-gohri/jira-ci-cd-integration/workflows/release/badge.svg"></a>
 
-</p>
+# Jira Development Integration
 
-# Jira CI/CD Integration
+Integrate your CI/CD pipeline's Build and Deployment information into the Jira Development Panel.
 
-Integrate your CI/CD pipeline information into the Jira Builds/Deployments Panel.
+![Builds Panel Preview](./docs/builds-panel.png)
 
 > Only supports Jira Cloud. Does not support Jira Server (hosted)
 
-![Builds Panel Preview](./docs/builds-panel.png)
-
 ## Prerequisites
 
 ### Generate Credentials
@@ -66,32 +63,93 @@ Generate new OAuth Credentials and copy
     client_secret: ${{ secrets.JIRA_CLIENT_SECRET }}
 ```
 
-#### Options
+## Use with Other CI/CD Providers
+
+Supported in providers which support running arbitrary Docker images (like Drone, Gitlab CI).
+
+Docker Images are available from:
+
+- Docker Hub: `boringdownload/jira-integration`
+- Github Container Registry: `ghcr.io/rohit-gohri/jira-ci-cd-integration`
+- Gitlab Container Registry: `registry.gitlab.com/rohit-gohri/jira-ci-cd-integration`
+
+Pick whatever you want and is convenient for you.
+
+### Set Env Vars
+
+Configuration for the Docker image is through env vars. Read more in [options](#options).
+
+#### Drone.io
+
+Add secrets for `JIRA_CLIENT_ID` and `JIRA_CLIENT_SECRET` and then add this to your pipeline:
+
+```yaml
+steps:
+  - name: jira-integration
+    image: boringdownload/jira-integration:v0
+    environment:
+      BUILD_NAME: drone-pipeline
+      JIRA_INSTANCE: companyname
+      JIRA_CLIENT_ID:
+        from_secret: jira_client_id
+      JIRA_CLIENT_SECRET:
+        from_secret: jira_client_secret
+```
+
+#### Gitlab CI/CD
+
+[Add a CI/CD Variable to your project](https://docs.gitlab.com/ee/ci/variables/#add-a-cicd-variable-to-a-project) for `JIRA_CLIENT_ID` and `JIRA_CLIENT_SECRET` and then add this step to your pipeline, preferably in the last stage.
+
+```yaml
+jira-integration:
+  image: registry.gitlab.com/rohit-gohri/jira-ci-cd-integration:v0
+  variables:
+    BUILD_NAME: gitlab-pipeline
+    JIRA_INSTANCE: companyname
+```
+
+## Options
+
+Provide these options directly in case of Github Actions or via the env variable in the brackets for Docker.
 
-##### jira_instance
+### Inputs
 
-Sub Domain of Jira Cloud Instance
+#### jira_instance (JIRA_INSTANCE)
 
-##### client_id
+Sub Domain of Jira Cloud Instance. This part of the url: `https://<jira_instance>.atlassian.net`
+
+#### client_id (JIRA_CLIENT_ID)
 
 ClientID of OAuth Creds
 
-##### client_secret
+#### client_secret (JIRA_CLIENT_SECRET)
 
 Client Secret of OAuth Creds
 
-##### event_type (optional)
+#### event_type (JIRA_EVENT_TYPE) (optional)
 
 "build" or "deployment", (default is "build")
 
-##### state (optional)
+#### state (BUILD_STATE) (optional)
 
-"successful"/"success", "failed", or "canceled" (default is "successful")
+"successful"/"success", "failed", or "canceled" (default is "unknown")
 
-##### issue (optional)
+#### issue (JIRA_ISSUES) (optional)
 
 Will be parsed from branch name automatically if absent. Or you can provide it according to your own logic. Can be multiple issues.
 
-##### token (optional)
+#### token (optional)
+
+> Only for Github Action
 
 Github Token to get commit message in Pull Request Events. Since github context doesn't have commit message, we use the Github API to get it from sha.
+
+### Pipeline Info
+
+#### Commit Message (COMMIT_MESSAGE)
+
+If you have the jira id in the commit message then provide this.
+
+#### Pipeline Name (BUILD_NAME)
+
+A name for your pipeline

action.yml

@@ -30,4 +30,4 @@ inputs:
     description: Will be parsed from branch name automatically
 runs:
   using: 'node12'
-  main: 'dist/index.js'
+  main: 'dist/github/index.js'