Skip to content

v1.0.0

Marketplace
Marketplace
Compare
Choose a tag to compare
@univdev univdev released this 12 Oct 19:13
· 11 commits to master since this release
v1.0.0
d5f2117
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Release v1.0.0 - Vercel Deploy with Slack Notification

We are excited to announce the release of v1.0.0 of the GitHub Action vercel-deploy-with-slack! This action simplifies the process of deploying your project to Vercel and sends real-time status updates to Slack using custom payloads for each deployment stage (start, success, and failure).

Key Features:

  • Vercel Deployment Integration: Authenticate with your Vercel account using the provided Vercel API token and deploy your project seamlessly.
  • Slack Notifications: Send real-time updates to your Slack channel through a customizable Incoming Webhook URL.
    • Deployment Start Message: Sends a custom Slack message when the deployment process begins.
    • Deployment Failure Message: Notifies the channel when the deployment fails, providing visibility into the issue.
    • Deployment Success Message: Sends a success notification once the deployment has completed successfully.
  • Custom Slack Payloads: Personalize each Slack message (start, failure, success) with tailored payloads for clear communication.
  • Process Time Calculation: The action outputs the total time taken to complete the deployment process.

Inputs:

  • vercel-token-id: Vercel API token for authenticating the deployment requests.
  • slack-webhook-url: Incoming Webhook URL to send the deployment status updates to Slack.
  • slack-deploy-start-message-payload: Custom payload for the deployment start message.
  • slack-deploy-failed-message-payload: Custom payload for the deployment failure message.
  • slack-deploy-succeed-message-payload: Custom payload for the deployment success message.

Outputs:

  • process-time: Total time taken to complete the deployment process.

How to Use:
Simply integrate this action into your GitHub workflows for automated Vercel deployments with Slack notifications. The flexibility in defining Slack message payloads allows you to tailor the messaging based on your team’s requirements.

Example Use Case:

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Deploy to Vercel and Notify Slack
        uses: univdev/[email protected]
        with:
          vercel-token-id: ${{ secrets.VERCEL_TOKEN }}
          slack-webhook-url: ${{ secrets.SLACK_WEBHOOK }}
          slack-deploy-start-message-payload: '{"text":"Deployment started!"}'
          slack-deploy-failed-message-payload: '{"text":"Deployment failed!"}'
          slack-deploy-succeed-message-payload: '{"text":"Deployment succeeded!"}'

We hope this action improves your CI/CD pipeline and enhances collaboration by keeping your team informed of deployment statuses in real-time!

Assets 2
Loading