Skip to content
play

GitHub Action

Find Linear Issue

v0.6 Latest version

Find Linear Issue

play

Find Linear Issue

Finds a Linear Issue from your pull request's branch, title, or description

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Find Linear Issue

              
  uses: Koleok/action-find-linear-issue@v0.6
Learn more about this action in Koleok/action-find-linear-issue

Choose a version

action-find-linear-issue

This is a Github Action that finds a Linear Issue in your Pull Request.

This is helpful when you're:

  • Ensuring each Pull Request has a Linear Issue.

Inputs

Input Description Required
linear-api-key Linear API key generated from https://linear.app/settings/api . (e.g. lin_api_*) ✅

Outputs

Output Description
linear-issue-id The Linear issue's unique identifier. (UUID)
linear-issue-identifier The Linear issue's human readable identifier. (e.g. ENG-123)
linear-issue-number The Linear issue's number. (e.g. the 123 of ENG-123)
linear-issue-title The Linear issue's title.
linear-issue-description The Linear issue's description.
linear-issue-url The Linear issue's URL. (e.g. https://...)
linear-team-id The Linear teams unique identifier. (UUID)
linear-team-key The Linear teams key/prefix (e.g. ENG)

Example usage

Create Linear Issue on Pull Request

name: Find Linear Issue in Pull Request

on:
  workflow_dispatch:
  pull_request:
    branches:
      - main
    types: [opened, reopened]

jobs:
  create-linear-issue-on-pull-request:
    runs-on: ubuntu-latest
    steps:
      - name: Find the Linear Issue
        id: findIssue
        uses: ctriolo/action-find-linear-issue@v1
        with:
          linear-api-key: ${{secrets.LINEAR_API_KEY}}

      - name: Create comment in PR with Linear Issue link
        uses: peter-evans/create-or-update-comment@v2
        with:
          token: ${{secrets.GITHUB_TOKEN}}
          issue-number: ${{ github.event.pull_request.number }}
          body: |
            [${{ steps.findIssue.outputs.linear-issue-identifier }}: ${{ steps.findIssue.outputs.linear-issue-title }}](${{ steps.findIssue.outputs.linear-issue-url }})