chore!: deprecate limit_to_pr_opened param

Author: DerekRoberts

.github/workflows/pr-open.yml

@@ -32,7 +32,6 @@ jobs:
       # Test with different inputs
       - uses: ./
         with:
-          limit_to_pr_opened: true
           add_markdown: |
             ---
 

README.md

@@ -22,8 +22,6 @@ This action adds to Pull Request descriptions using markdown.  It checks if the
 
 `github_token`: ${{ secrets.GITHUB_TOKEN }} or a Personal Access Token (PAT).  Default is to inherit a token from the calling workflow.
 
-`limit_to_pr_opened`: Only take action when PR status is opened or reopened.  Default = false.
-
 ## Permissions
 
 #### Explicit rights
@@ -82,7 +80,6 @@ jobs:
       - uses: bcgov/action-pr-description-add@main
         with:
           github_token: "${{ secrets.GITHUB_TOKEN }}"
-          limit_to_pr_opened: "true"
           add_markdown: |
             ---
 
@@ -104,6 +101,10 @@ BC Government QuickStart for OpenShift - [Issues](https://github.com/bcgov/quick
 
 BC Government QuickStart for OpenShift - [Discussions](https://github.com/bcgov/quickstart-openshift/discussions)
 
+## Deprecations
+
+The parameter `limit_to_pr_opened` was deprecated due to non-use.  Using this parameter will result in a warning only.
+
 ## Contributing
 
 Contributions are always welcome!  Please send us pull requests or get in touch at the links above.

action.yml

@@ -12,9 +12,6 @@ inputs:
   github_token:
     description: "GitHub token or a Personal Access Token (PAT)"
     default: ${{ github.token }}
-  limit_to_pr_opened:
-    description: "Only run when a PR is opened or reopened, not pushed"
-    default: "false"
 
 runs:
   using: "node20"

src/main.ts

@@ -4,22 +4,13 @@ import {context, getOctokit} from '@actions/github'
 // Action input
 const markdown = getInput('add_markdown')
 const token = getInput('github_token')
-const limit_to_pr_opened = getInput('limit_to_pr_opened')
 
-if (!markdown || !token || !limit_to_pr_opened) {
+if (!markdown || !token) {
   error('Error: please verify input!')
 }
 
 // Main function
 async function action(): Promise<void> {
-  // If limit_to_pr_opened is true, verify status (opened, reopened)
-  const trigger = context.payload.action || ''
-  const statuses = ['opened', 'reopened']
-  if (limit_to_pr_opened === 'true' && !statuses.includes(trigger)) {
-    info('PR not opened or reopened with limit_to_pr_opened=true. Exiting.')
-    return
-  }
-
   // Ensure pull request exists
   if (!context.payload.pull_request) {
     error('Error: No pull request found in context. Exiting.')