README cleanup

Author: nrpx

.github/workflows/pull-request.yml

@@ -29,10 +29,12 @@ jobs:
 
       - name: Create comment in PR with Linear Issue link
         uses: peter-evans/create-or-update-comment@v2
+        env:
+          issue_identifier: ${{ fromJson(steps.findIssue.outputs.linear-issue).identifier }}
+          issue_title: ${{ fromJson(steps.findIssue.outputs.linear-issue).title }}
+          issue_url: ${{ fromJson(steps.findIssue.outputs.linear-issue).url }}
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           issue-number: ${{ github.event.pull_request.number }}
           body: |
-            ```yaml
-            ${{ toJson(steps.findIssue.outputs.linear-issue) }}
-            ```
+            [${{ env.issue_identifier }}: ${{ env.issue_title }}](${{ env.issue_url }})

README.md

@@ -5,23 +5,25 @@ This is a [Github Action](https://github.com/features/actions) that finds a [Lin
 This is helpful when you're:
 
 - Ensuring each Pull Request has a Linear Issue.
+- Making a forced PR title/description updates depends on data from Linear
+- Adjusting release notes on GitHub or somewhere else via PRs (actions) and Linear Issues 
 
 ## Inputs
 
-| Input            | Description                                                                        | Required |
-| ---------------- | ---------------------------------------------------------------------------------- | -------- |
-| `linear-api-key` | Linear API key generated from https://linear.app/settings/api . (e.g. `lin_api_*)` | ✅       |
-| `output-multiple` | Find multiple issues and output a JSON array of results (default `false`) | ❌      |
-| `include-title` | Taking the PR title into account to find issues (default `false`) | ❌       |
-| `include-description` | Taking the PR description into account to find issues (default `false`) | ❌       |
-| `include-branch-name` | Taking the PR branch name into account to find issues (default `true`) | ❌       |
-| `with-team` | Include `team` node into each resulted `issue` (default `true`) | ❌       |
-| `with-labels` | Include `labels` nodes into each resulted `issue` (default `true`) | ❌       |
+| Input                 | Description                                                                        | Required |
+|-----------------------|------------------------------------------------------------------------------------|----------|
+| `linear-api-key`      | Linear API key generated from https://linear.app/settings/api . (e.g. `lin_api_*)` | ✅        |
+| `output-multiple`     | Find multiple issues and output a JSON array of results (default `false`)          | 🚫       |
+| `include-title`       | Taking the PR title into account to find issues (default `false`)                  | 🚫       |
+| `include-description` | Taking the PR description into account to find issues (default `false`)            | 🚫       |
+| `include-branch-name` | Taking the PR branch name into account to find issues (default `true`)             | 🚫       |
+| `with-team`           | Include `team` node into each resulted `issue` (default `true`)                    | 🚫       |
+| `with-labels`         | Include `labels` nodes into each resulted `issue` (default `true`)                 | 🚫       |
 
 ## Outputs
 
 | Output          | Description                                                      |
-| --------------- | ---------------------------------------------------------------- |
+|-----------------|------------------------------------------------------------------|
 | `linear-issue`  | The Linear issue in JSON format                                  |
 | `linear-issues` | The Linear issues as JSON array (when `output-multiple` is used) |
 
@@ -45,15 +47,19 @@ jobs:
     steps:
       - name: Find the Linear Issue
         id: findIssue
-        uses: ctriolo/action-find-linear-issue@v1
+        uses: nrpx/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
+        env:
+          issue_identifier: ${{ fromJson(steps.findIssue.outputs.linear-issue).identifier }}
+          issue_title: ${{ fromJson(steps.findIssue.outputs.linear-issue).title }}
+          issue_url: ${{ fromJson(steps.findIssue.outputs.linear-issue).url }}
         with:
-          token: ${{secrets.GITHUB_TOKEN}}
+          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 }})
+            [${{ env.issue_identifier }}: ${{ env.issue_title }}](${{ env.issue_url }})
 ```