add some further info to enforce Jira issue workflow

workflow-templates/enforce-jira-issue-key.yml

@@ -1,5 +1,12 @@
 name: Ensure Jira issue is linked
 
+# make sure to add the following secrets to your repository before integrating this workflow
+# the user needs to have at lease "View" permissions in your project to be able to search for issues
+# TIP_JIRA_URL - the URL of Jira that issues will be searched in
+# TIP_JIRA_USER_EMAIL - the email address of the user to authenticate with
+# TIP_JIRA_API_TOKEN - the API token to use for authentication
+# more info: https://github.com/atlassian/gajira-login#enviroment-variables
+
 on:
   pull_request:
     types: [opened, edited, reopened, synchronize]
@@ -34,4 +41,4 @@ jobs:
           if [[ -z "${{ steps.issue_key_pr_title.outputs.issue }}" && -z "${{ steps.issue_key_branch_name.outputs.issue }}" ]]; then
              echo "Jira issue key could not be found!"
              exit 1
-          fi
+          fi