feat: add policy output

> Policy that was used to set labels on issue. Value is a stringified JSON object.

README.md

@@ -321,6 +321,33 @@ List of labels that were set based on the provided policy. The output is a strin
 > element: ${{ fromJSON(steps.<step-id>.outputs.labels)[0] }}
 > ```
 
+### policy
+
+The representation of the policy that was used to set labels. The output is a stringified JSON object.
+
+Example output in JSON format where:
+
+* `template` - the name of the template that was used to parse the issue form
+* `section` - key-value pairs where the key is the ID of the issue-form section and the value is an array of the applied labels for the given section
+
+```json
+{
+  "template": "bug.yml",
+  "section": {
+    "severity": [ "low" ],
+    "priority": [ "high" ]
+  }
+}
+```
+
+> [!TIP]
+>
+> Use [`fromJSON`](https://docs.github.com/en/actions/learn-github-actions/expressions#fromjson) function to parse the output to get an object of policy.
+>
+> ```yml
+> severity: ${{ fromJSON(steps.<step-id>.outputs.policy).section.severity }}
+> ```
+
 ## Policy
 
 It's possible to define a labeling policy to further customize the labeling process. The policy can be defined using `.github/advanced-issue-labeler.yml` configuration file. The structure needs to be as follows:

action.yml

@@ -38,6 +38,8 @@ inputs:
 outputs:
   labels:
     description: Labels that were set on issue. Value is a stringified array.
+  policy:
+    description: Policy that was used to set labels on issue. Value is a stringified JSON object.
 
 runs:
   using: node20

src/action.ts

@@ -24,13 +24,17 @@ async function action(octokit: CustomOctokit) {
 
   const labels = labeler.gatherLabels();
 
+  setOutput('labels', JSON.stringify(labels ?? []));
+  setOutput('policy', JSON.stringify(labeler.outputPolicy));
+
   // Check if there are some labels to be set
   if (!labels || (Array.isArray(labels) && labels?.length < 1)) {
     info('Nothing to do here. CY@');
     return;
   }
 
   info(`Labels to be set: ${labels}`);
+  info(`Used policy: ${JSON.stringify(labeler.outputPolicy, null, 2)}`);
 
   const response = await octokit.request(
     'POST /repos/{owner}/{repo}/issues/{issue_number}/labels',
@@ -41,8 +45,6 @@ async function action(octokit: CustomOctokit) {
     }
   );
 
-  setOutput('labels', JSON.stringify(labels));
-
   debug(`GitHub API response status: [${response.status}]`);
 }
 

src/labeler.ts

@@ -4,6 +4,7 @@ import { Config } from './config';
 import { IssueForm } from './issue-form';
 
 import { BlockList, Section, Template } from './schema/input';
+import { OutputPolicy } from './schema/output';
 
 export class Labeler {
   section: Section | undefined = undefined;
@@ -13,6 +14,11 @@ export class Labeler {
   isConfig: boolean;
   isInputs: boolean;
 
+  outputPolicy: OutputPolicy = {
+    template: '',
+    section: {},
+  };
+
   constructor(
     public issueForm: IssueForm,
     public config: Config
@@ -31,6 +37,7 @@ export class Labeler {
     }
     // Config requires template as well
     this.template = getInput('template');
+    this.outputPolicy.template = this.template;
   }
 
   gatherLabels() {
@@ -59,6 +66,8 @@ export class Labeler {
       return;
     }
 
+    this.outputPolicy.section[this.section] = keywords;
+
     return keywords;
   }
 
@@ -105,6 +114,12 @@ export class Labeler {
             )
           ) {
             labels.push(rule.name);
+
+            if (!this.outputPolicy.section.hasOwnProperty(singleID)) {
+              this.outputPolicy.section[singleID] = [];
+            }
+
+            this.outputPolicy.section[singleID]?.push(rule.name);
           }
         }
       }

src/schema/output.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+
+const outputPolicySchema = z.object({
+  template: z.string(),
+  section: z.record(z.array(z.string())),
+});
+
+export type OutputPolicy = z.infer<typeof outputPolicySchema>;