Merge pull request #2 from univdev/develop

PR for v1.0.0 version release (#1)

Author: univdev

.gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

README.md

@@ -1 +1,75 @@
-# Github Action for Vercel deploy
+# Vercel deploy with slack
+
+**GitHub Action for Vercel Distribution and Slack Message Transfer**
+
+This action helps automate deployments to Vercel while sending real-time status updates to a Slack channel via custom message payloads.
+
+## Inputs
+
+| Name                               | Description                                                                | Required |
+|------------------------------------ |----------------------------------------------------------------------------|----------|
+| `vercel-token-id`                  | Vercel API token for authenticating deployment requests.                   | `true`   |
+| `slack-webhook-url`                | Slack Incoming Webhook URL for sending deployment status updates.           | `true`   |
+| `slack-deploy-start-message-payload`| Custom payload for the message to be sent when the deployment starts.       | `true`   |
+| `slack-deploy-failed-message-payload`| Custom payload for the message to be sent if the deployment fails.         | `true`   |
+| `slack-deploy-succeed-message-payload`| Custom payload for the message to be sent when the deployment succeeds.    | `true`   |
+
+## Outputs
+
+| Name             | Description                                     |
+|------------------|-------------------------------------------------|
+| `process-time`   | The total time taken to complete the deployment.|
+
+## Example Usage
+
+```yaml
+name: Deploy to Vercel with Slack Notifications
+
+on: [push]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      
+      - name: Deploy with Slack notifications
+        uses: univdev/vercel-deploy-with-slack@v1
+        with:
+          vercel-token-id: ${{ secrets.VERCEL_TOKEN }}
+          slack-webhook-url: ${{ secrets.SLACK_WEBHOOK_URL }}
+          slack-deploy-start-message-payload: '{"text": "Deployment has started..."}'
+          slack-deploy-failed-message-payload: '{"text": "Deployment failed!"}'
+          slack-deploy-succeed-message-payload: '{"text": "Deployment succeeded!"}'
+```
+
+## Inputs Explanation
+
+- vercel-token-id: This is your Vercel API token, required to authenticate the deployment request. Make sure to store this token as a GitHub secret.
+- slack-webhook-url: Your Slack Incoming Webhook URL where deployment status updates will be sent. Also recommended to store as a GitHub secret.
+- slack-deploy-start-message-payload: A custom JSON payload defining the message that will be sent when the deployment starts. Typically includes a text field, but you can customize it according to your Slack API payload format.
+- slack-deploy-failed-message-payload: A custom JSON payload that is sent if the deployment fails.
+- slack-deploy-success-message-payload: A custom JSON payload that is sent when the deployment succeeds.
+
+## Outputs
+- process-time: The action outputs the total time taken to complete the deployment process, which can be used for further logging or metrics.
+Customizing Slack Messages
+
+To customize the Slack messages, use Slack's message formatting capabilities. Here's an example of a basic message payload:
+
+```json
+{
+  "text": "Deployment started for project XYZ.",
+  "attachments": [
+    {
+      "text": "We're deploying the latest changes.",
+      "color": "#36a64f"
+    }
+  ]
+}
+```
+
+You can pass similar JSON payloads as values to the Slack-related inputs.
+
+Slack message format guide: [Here!](https://api.slack.com/messaging/webhooks)

action.yaml

@@ -0,0 +1,24 @@
+name: vercel-deploy-with-slack
+description: Github Action for Vercel Distribution and Slack Message Transfer
+inputs:
+  vercel-token-id:
+    description: 'Vercel API token for authenticating deployment requests.'
+    required: true
+  slack-webhook-url:
+    description: 'Slack Incoming Webhook URL for sending deployment status updates.'
+    required: true
+  slack-deploy-start-message-payload:
+    description: 'Custom payload for the message to be sent when the deployment starts.'
+    required: true
+  slack-deploy-failed-message-payload:
+    description: 'Custom payload for the message to be sent if the deployment fails.'
+    required: true
+  slack-deploy-succeed-message-payload:
+    description: 'Custom payload for the message to be sent when the deployment succeeds.'
+    required: true
+outputs:
+  process-time:
+    description: 'The total time taken to complete the deployment process.'
+runs:
+  using: 'node20'
+  main: 'dist/main'

package.json

@@ -1,8 +1,20 @@
 {
   "name": "vercel-deploy-with-slack",
+  "type": "module",
   "version": "1.0.0",
   "description": "Github Action for Vercel Distribution and Slack Message Transfer",
-  "main": "index.js",
+  "main": "dist/index.js",
   "author": "univdev <[email protected]>",
-  "license": "ISC"
+  "license": "ISC",
+  "scripts": {
+    "build": "tsc && vite build"
+  },
+  "devDependencies": {
+    "typescript": "^5.5.3",
+    "vite": "^5.4.8"
+  },
+  "dependencies": {
+    "@actions/core": "^1.11.1",
+    "@types/node": "^22.7.5"
+  }
 }