Releases: univdev/vercel-deploy-with-slack
v1.1.1
Bug Fixed
- Not working
npx vercel pull --yes
Command line - Update
dist
files.
v1.1.0
Release v1.1.0 - Vercel Deploy with Slack Notification
We are thrilled to introduce v1.1.0 of the vercel-deploy-with-slack
GitHub Action! This release brings added flexibility and customization for Slack notifications, allowing for a more dynamic integration with your CI/CD pipeline.
What's New:
- Optional Slack Integration: Slack webhook inputs are now optional. If no Slack URL or payload is provided, the action can proceed without sending notifications, offering a more flexible use case for teams that may not always require Slack updates.
- Payload File Support: You can now specify a file path for your Slack notification payloads, providing an alternative way to define custom messages outside of the workflow YAML.
slack-deploy-start-message-payload-file
: A file containing the custom payload for the deployment start message. Overrides the inline payload if both are provided.slack-deploy-failed-message-payload-file
: A file containing the custom payload for the deployment failure message. Overrides the inline payload if both are provided.slack-deploy-succeed-message-payload-file
: A file containing the custom payload for the deployment success message. Overrides the inline payload if both are provided.
- Backward Compatibility: Existing inputs for inline Slack message payloads (
slack-deploy-start-message-payload
,slack-deploy-failed-message-payload
, andslack-deploy-succeed-message-payload
) remain supported, ensuring compatibility with previous configurations.
Inputs:
vercel-token-id
: Vercel API token for authenticating the deployment requests.slack-webhook-url
(optional): Incoming Webhook URL to send the deployment status updates to Slack.slack-deploy-start-message-payload
(optional): Custom payload for the deployment start message.slack-deploy-failed-message-payload
(optional): Custom payload for the deployment failure message.slack-deploy-succeed-message-payload
(optional): Custom payload for the deployment success message.slack-deploy-start-message-payload-file
(optional): File path for a custom payload for the deployment start message.slack-deploy-failed-message-payload-file
(optional): File path for a custom payload for the deployment failure message.slack-deploy-succeed-message-payload-file
(optional): File path for a custom payload for the deployment success message.
Outputs:
process-time
: Total time taken to complete the deployment process.
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-file: './slack_payloads/start.json'
slack-deploy-failed-message-payload-file: './slack_payloads/failed.json'
slack-deploy-succeed-message-payload-file: './slack_payloads/success.json'
This update makes it easier to manage Slack notifications and adapt them to your team's specific needs, whether by using inline messages or files for better organization. We hope these enhancements improve your deployment process and help maintain seamless communication with your team!
v1.0.0
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!