Get the PR info by ID or associated commit (#12)

## What
* Extend GHA to support retrieving PR by ID
* Replaced usage of npm with yarn
* Added tests for getting PR by PR ID
* Copy `package.json` and `jest` configs from cloudposse typescript actions

## Why
* Working with issue comments, we have PR ID  instead of commit SHA in the context.
* Standardazise toolchain 
* Improve test coverage
* Standardazise config and workflows


## References
* https://github.com/cloudposse/.github/pull/117/files#diff-90dcedcd84c3e38439050ef7ae1df7289d0c0b842f39f9f84fbd33c4de8f122fR22

Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]>

---------

Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]>

Author: goruha

.eslintignore

@@ -1,4 +1,4 @@
-dist/
 lib/
+dist/
 node_modules/
-jest.config.js
+coverage/

.gitattributes

@@ -1,2 +1,3 @@
-* text=auto
+* text=auto eol=lf
+
 dist/** -diff linguist-generated=true

.github/settings.yml

@@ -3,6 +3,6 @@ _extends: .github
 
 repository:
   name: get-pr
-  description: Get the PR info associated with the commit
+  description: Get the PR info by ID or associated commit
   homepage: https://cloudposse.com/accelerate
   topics: "github-action"

.github/workflows/build-and-test.yml

@@ -28,7 +28,7 @@ jobs:
           node-version-file: package.json
           cache: yarn
       - name: install dependencies
-        run: yarn install --frozen-lockfile --prefer-offline
+        run: yarn add ci
       - uses: cloudposse/github-action-setup-atmos@v2
         with:
           install-wrapper: false
@@ -43,10 +43,10 @@ jobs:
         with:
           node-version: '20'
           cache: 'npm'
-      - run: npm ci
+      - run: yarn add ci
       - name: Build Action
         run: |
-          npm run build
+          yarn build
       - name: Run Action
         uses: ./
         id: pr
@@ -66,10 +66,10 @@ jobs:
         with:
           node-version: '20'
           cache: 'npm'
-      - run: npm ci
+      - run: yarn add ci
       - name: Build Action
         run: |
-          npm run build
+          yarn build
       - name: Run Action
         uses: ./
         id: pr

.gitignore

@@ -96,11 +96,11 @@ Thumbs.db
 
 # Ignore built ts files
 __tests__/runner/*
-lib/**/*
-
-#Idea
-.idea/
 
+# IDE files
+.idea
+.vscode
+*.code-workspace
 
 .build-harness
 build-harness

.node-version

@@ -0,0 +1 @@
+20.6.0

.prettierignore

@@ -1,3 +1,3 @@
 dist/
-lib/
-node_modules/
+node_modules/
+coverage/

.prettierrc.json

@@ -4,7 +4,13 @@
   "useTabs": false,
   "semi": false,
   "singleQuote": true,
+  "quoteProps": "as-needed",
+  "jsxSingleQuote": false,
   "trailingComma": "none",
-  "bracketSpacing": false,
-  "arrowParens": "avoid"
+  "bracketSpacing": true,
+  "bracketSameLine": true,
+  "arrowParens": "avoid",
+  "proseWrap": "always",
+  "htmlWhitespaceSensitivity": "css",
+  "endOfLine": "lf"
 }

README.yaml

@@ -35,6 +35,44 @@ references: []
 
 # How to use this project
 usage: |-
+  This action will retrieve the PR metadata by `id` (PR number) or commit `sha`.
+  The `id` takes precedence over `sha`, if both are passed.
+  
+  ### By ID
+  
+  ```yaml
+    on:
+      pull_request:
+        branches:
+          - main
+        types: [opened, synchronize, reopened]
+
+    jobs:
+      pr:
+        name: PR Info
+        runs-on: ubuntu-latest
+        steps:
+          - uses: cloudposse-github-actions/get-pr@main
+            id: pr
+            with:
+              id: ${{ github.event.number }}
+        outputs:
+          base: ${{ fromJSON(steps.pr.outputs.pr).base.sha }}
+          head: ${{ fromJSON(steps.pr.outputs.pr).head.sha }}
+          found: ${{ steps.pr.outputs.found }}
+          json: ${{ steps.pr.outputs.json }}
+          number: ${{ steps.pr.outputs.number }}
+          title: ${{ steps.pr.outputs.title }}
+          body: ${{ steps.pr.outputs.body }}
+          url: ${{ steps.pr.outputs.url }}
+          created_at: ${{ steps.pr.outputs.created_at }}
+          merged_at: ${{ steps.pr.outputs.merged_at }}
+          closed_at: ${{ steps.pr.outputs.closed_at }}
+          labels: ${{ steps.pr.outputs.labels }}
+  ```
+
+  ### By SHA
+  
   ```yaml
     on:
       push:
@@ -62,6 +100,7 @@ usage: |-
           closed_at: ${{ steps.pr.outputs.closed_at }}
           labels: ${{ steps.pr.outputs.labels }}
   ```
+
 include:
   - "docs/github-action.md"