Updated the repo to have 1 action

.github/workflows/test.yml

@@ -7,6 +7,15 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: ./
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - uses: .
         with:
-        # input params if you have any
+          type: 'jira'
+          port_client_id: ${{ secrets.PORT_CLIENT_ID }}
+          port_client_secret: ${{ secrets.PORT_CLIENT_SECRET }}
+          config: |
+            jira_host: ${{ secrets.JIRA_HOST }}
+            atlassian_user_email: ${{ secrets.JIRA_USER_EMAIL }}
+            atlassian_user_token: ${{ secrets.JIRA_USER_TOKEN }}

.gitignore

@@ -0,0 +1,96 @@
+__tests__/runner/*
+
+node_modules/
+lib/
+
+# Rest pulled from https://github.com/github/gitignore/blob/master/Node.gitignore
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# Text editor files
+.vscode/

LICENSE

@@ -1,3 +1,4 @@
+
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
@@ -198,4 +199,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

README.md

@@ -1 +1,61 @@
-# ocean-github-action
+<!-- action-docs-header action="action.yml" -->
+
+<!-- action-docs-header action="action.yml" -->
+
+<img align="right" width="100" height="74" src="https://user-images.githubusercontent.com/8277210/183290025-d7b24277-dfb4-4ce1-bece-7fe0ecd5efd4.svg" />
+
+# Ocean Sail GitHub Action - by getPort.io
+
+[![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white)](https://www.getport.io/community)
+
+<!-- action-docs-description action="action.yml" -->
+## Description
+
+Runs the Ocean Sail command for a specific type of integration
+<!-- action-docs-description action="action.yml" -->
+
+The `sail` command is part of the Ocean framework and is used to run integrations.
+
+Read more about the Ocean framework [here](https://ocean.getport.io/)
+
+<!-- action-docs-inputs action="action.yml" -->
+## Inputs
+
+| name | description | required | default |
+| --- | --- | --- | --- |
+| `type` | <p>The type of the integration to run</p> | `true` | `""` |
+| `identifier` | <p>The identifier of the integration to run</p> | `false` | `""` |
+| `port_client_id` | <p>The Port client id</p> | `true` | `""` |
+| `port_client_secret` | <p>The Port client secret</p> | `true` | `""` |
+| `initialize_port_resources` | <p>Should ocean try to create the default blueprints, pages &amp; integration config for the integration</p> | `false` | `true` |
+| `config` | <p>The configuration for the integration</p> | `false` | `""` |
+| `platform` | <p>The platform to run the integration on</p> | `false` | `linux/amd64` |
+| `image` | <p>The image to run the integration from</p> | `false` | `""` |
+| `version` | <p>The version of the integration to run</p> | `false` | `latest` |
+<!-- action-docs-inputs action="action.yml" -->
+
+<!-- action-docs-outputs action="action.yml" -->
+## Outputs
+
+| name | description |
+| --- | --- |
+| `exit_code` | <p>The exit code of the Ocean Sail command</p> |
+<!-- action-docs-outputs action="action.yml" -->
+
+## Available integration types
+
+All available integration types are listed in the [Ocean integrations library](https://ocean.getport.io/integrations-library/) and can also be found in the data sources menu in the Port UI.
+
+## Example usage
+
+```yaml
+- uses: ocean-github-action/sail@v1
+  with:
+    type: 'jira'
+    port_client_id: ${{ secrets.PORT_CLIENT_ID }}
+    port_client_secret: ${{ secrets.PORT_CLIENT_SECRET }}
+    config: |
+      jira_host: ${{ secrets.JIRA_HOST }}
+      atlassian_user_email: ${{ secrets.ATLASSIAN_USER_EMAIL }}
+      atlassian_user_token: ${{ secrets.ATLASSIAN_USER_TOKEN }}
+```

RELEASES.md

@@ -0,0 +1,5 @@
+# Releases
+
+### 1.0.0
+- Initial release of the ocean sail action
+

action.yml

@@ -0,0 +1,89 @@
+name: '🌊 Ocean Sail'
+description: 'Runs the Ocean Sail command for a specific type of integration'
+inputs:
+  type:
+    description: 'The type of the integration to run'
+    required: true
+  identifier:
+    description: 'The identifier of the integration to run'
+    required: false
+  port_client_id:
+    description: 'The Port client id'
+    required: true
+  port_client_secret:
+    description: 'The Port client secret'
+    required: true
+  initialize_port_resources:
+    description: 'Should Ocean try to create the default resources (blueprints, pages, integration config, etc.) provided with the integration'
+    required: false
+    default: 'true'
+  config:
+    description: 'The configuration for the integration'
+    required: false
+
+  # Misc inputs
+  platform:
+    description: 'The platform to run the integration on'
+    required: false
+    default: 'linux/amd64'
+  image:
+    description: 'The image to run the integration from'
+    required: false
+  version:
+    description: 'The version of the integration to run'
+    required: false
+    default: 'latest'
+outputs:
+  exit_code:
+    description: 'The exit code of the Ocean Sail command'
+    value: ${{ steps.ocean-sail.outputs.exit_code }}
+runs:
+  using: "composite"
+  steps:
+    - name: ✅ Validate inputs
+      shell: bash
+      run: |
+        [[ "${{ inputs.type }}" ]] || { echo "type input is empty" ; exit 1; }
+        [[ "${{ inputs.port_client_id }}" ]] || { echo "inputs.port_client_id input is empty" ; exit 1; }
+        [[ "${{ inputs.port_client_secret }}" ]] || { echo "inputs.port_client_secret input is empty" ; exit 1; }
+        [[ "${{ inputs.initialize_port_resources }}" ]] || { echo "inputs.initialize_port_resources input is empty" ; exit 1; }
+        [[ "${{ inputs.event_listener_type }}" ]] || { echo "inputs.event_listener_type input is empty" ; exit 1; }
+        [[ "${{ inputs.platform }}" ]] || { echo "inputs.platform input is empty" ; exit 1; }
+        [[ "${{ inputs.version }}" ]] || { echo "inputs.version input is empty" ; exit 1; }
+
+    - name: 🌊 Run Ocean Sail dockerized
+      shell: bash
+      run: |
+        image_name="ghcr.io/port-labs/port-ocean-${{ inputs.type }}:${{ inputs.version }}"
+        if [[ "${{ inputs.image }}" ]]; then
+          image_name="${{ inputs.image }}:${{ inputs.version }}"
+        fi
+
+        echo "OCEAN__PORT__CLIENT_ID=${{ inputs.port_client_id }}" >> .env
+        echo "OCEAN__PORT__CLIENT_SECRET=${{ inputs.port_client_secret }}" >> .env
+
+        echo "OCEAN__EVENT_LISTENER={\"type\":\"ONCE\"}" >> .env
+        echo "OCEAN__INITIALIZE_PORT_RESOURCES=${{ inputs.initialize_port_resources }}" >> .env
+
+        if [[ "${{ inputs.identifier }}" ]]; then
+          echo "OCEAN__INTEGRATION__IDENTIFIER=${{ inputs.identifier }}" >> .env
+        fi
+
+        if [[ "${{ inputs.config }}" ]]; then
+          for key in $(echo "${{ inputs.config }}" | yq eval "keys | .[]"); do
+            value=$(echo "${{ inputs.config }}" | yq eval ".$key")
+            upper_key=$(echo $key | tr '[:lower:]' '[:upper:]')
+            echo "OCEAN__INTEGRATION__CONFIG__${upper_key}=${value}" >> .env
+          done
+        fi
+
+        env >> .env
+
+        docker run -i --rm --platform=${{ inputs.platform }} --env-file .env $image_name
+
+        echo "exit_code=$?" >> $GITHUB_ENV
+
+    - name: 🧹 Cleanup
+      if: always()
+      shell: bash
+      run: rm .env