Get Started

  1. Open any Jira project, navigate to Project Pages, and select the Vercel DevOps for Jira app:

Selecting the Vercel DevOps for Jira app in the Jira project pages

  1. When opening the app for the first time, you will see an empty state. You can click on “Connect Vercel Projects” to get forwarded to the project settings page.

Initial empty state of the Vercel DevOps for Jira app

  1. There, you can provide a Vercel API token to allow the app to access your Vercel projects:

API token input field prompting for a Vercel token

Learn how to create an API token for Vercel.

  1. After saving the API token, a list of available Vercel projects opens. Select the Vercel projects you’d like to connect to this Jira project:

Selecting Vercel projects to connect with the Jira project

  1. Click “Connect” to link the selected projects:

Connecting selected Vercel projects

After a successful connection, you’ll see a confirmation:

Successfully connected Vercel projects

  1. If you go back to the project’s overview page, you’ll see all connected Vercel projects for this Jira project:

Overview page showing connected Vercel projects

  1. Now you’re ready to to track deployments on issues. To do this, make a change in the Git repository in one of your connected Vercel projects. Make sure to include a Jira issue key in your commit message (e.g. feat: setup basic website structure TEST-2):

Git commit message containing a Jira issue key

  1. Once a deployment completes, the deployment information appears on the Jira issue:

Deployment information displayed in the Jira issue panel

If you click on “View all deployment information”, you can view the latest deployments associated with the issue:

Latest deployments linked to the Jira issue

Now you can continue to track Vercel deployments alongside Jira issues. Also check out the smart links feature for Vercel urls that allow you to see additional information for links to a Vercel team, project or deployment inside an issue description or a comment.