Adds error-message output for validate-pull-request-title

validate-pull-request-title/README.md

@@ -78,6 +78,12 @@ A comma-separated list of prefixes that are allowed in pull request titles.
 
 A boolean indicating whether the pull request title is valid.
 
+### `error-message`
+
+A detailed message indicating why the pull request title is invalid. This may
+include information such as exceeding maximum length, not meeting minimum
+length, or lacking required prefixes.
+
 ## License
 
 This action is licensed under the [MIT License](LICENSE).

validate-pull-request-title/__tests__/main.test.ts

@@ -29,14 +29,18 @@ describe("run function", () => {
 
   it("should set is-valid to false if validateTitleLength fails", async () => {
     // arrange
+    const errorMessage = "Title length not valid";
     const mockInputs = {
       pullRequestTitle: "Test PR",
       caseSensitivePrefix: true,
       maxLengthTitle: 100,
       minLengthTitle: 10,
       allowedPrefixes: ["Test"]
     };
-    const mockLengthValidation = { isValid: false, message: undefined }; // Invalid result
+    const mockLengthValidation = {
+      isValid: false,
+      message: errorMessage
+    }; // Invalid result
     const validateInputsSpy = jest
       .spyOn(Validators, "validateInputs")
       .mockResolvedValue(mockInputs);
@@ -56,10 +60,15 @@ describe("run function", () => {
       mockInputs.maxLengthTitle
     );
     expect(coreSetOutputSpy).toHaveBeenCalledWith("is-valid", false);
+    expect(coreSetOutputSpy).toHaveBeenCalledWith(
+      "error-message",
+      errorMessage
+    );
   });
 
   it("should set is-valid to false if validateTitlePrefixes fails", async () => {
     // arrange
+    const errorMessage = "Title prefix not valid";
     const mockInputs = {
       pullRequestTitle: "Test PR",
       caseSensitivePrefix: true,
@@ -70,7 +79,7 @@ describe("run function", () => {
     const mockLengthValidation = { isValid: true }; // Valid result
     const mockPrefixesValidation = {
       isValid: false,
-      message: undefined
+      message: errorMessage
     }; // Invalid result
     const validateInputsSpy = jest
       .spyOn(Validators, "validateInputs")
@@ -99,6 +108,10 @@ describe("run function", () => {
       mockInputs.caseSensitivePrefix
     );
     expect(coreSetOutputSpy).toHaveBeenCalledWith("is-valid", false);
+    expect(coreSetOutputSpy).toHaveBeenCalledWith(
+      "error-message",
+      errorMessage
+    );
   });
 
   it("should call core.info if all validations pass", async () => {
@@ -122,6 +135,7 @@ describe("run function", () => {
       .spyOn(Validators, "validateTitlePrefixes")
       .mockReturnValue(mockPrefixesValidation);
     const coreInfoSpy = jest.spyOn(core, "info");
+    const coreSetOutputSpy = jest.spyOn(core, "setOutput");
 
     // act
     await run();
@@ -133,6 +147,7 @@ describe("run function", () => {
     expect(coreInfoSpy).toHaveBeenCalledWith(
       "Pull Request title validation passed."
     );
+    expect(coreSetOutputSpy).toHaveBeenCalledWith("is-valid", true);
   });
 
   it("should throw an error with specific message if error is not an instance of Error", async () => {
@@ -142,6 +157,7 @@ describe("run function", () => {
       .spyOn(Validators, "validateInputs")
       .mockRejectedValue(error);
     const coreSetFailedSpy = jest.spyOn(core, "setFailed");
+    const coreSetOutputSpy = jest.spyOn(core, "setOutput");
 
     // act
     await run();
@@ -151,5 +167,6 @@ describe("run function", () => {
     expect(coreSetFailedSpy).toHaveBeenCalledWith(
       "Failed to validate pull request title: Unknown error"
     );
+    expect(coreSetOutputSpy).not.toHaveBeenCalled();
   });
 });

validate-pull-request-title/action.yml

@@ -24,6 +24,10 @@ inputs:
 outputs:
   is-valid:
     description: Indicates if the title is valid or not
+  error-message:
+    ddescription: |
+      A detailed message indicating why the pull request title is invalid. 
+      This may include information such as exceeding maximum length, not meeting minimum length, or lacking required prefixes.
 
 runs:
   using: node20

validate-pull-request-title/dist/index.js

@@ -24954,11 +24954,13 @@ async function run() {
         const lengthValidation = (0, validators_1.validateTitleLength)(pullRequestTitle, minLengthTitle, maxLengthTitle);
         if (!lengthValidation.isValid) {
             core.setOutput("is-valid", false);
+            core.setOutput("error-message", lengthValidation.message);
             return;
         }
         const prefixesValidation = (0, validators_1.validateTitlePrefixes)(pullRequestTitle, allowedPrefixes, caseSensitivePrefix);
         if (!prefixesValidation.isValid) {
             core.setOutput("is-valid", false);
+            core.setOutput("error-message", prefixesValidation.message);
             return;
         }
         core.info("Pull Request title validation passed.");

validate-pull-request-title/src/main.ts

@@ -22,6 +22,7 @@ export async function run(): Promise<void> {
     );
     if (!lengthValidation.isValid) {
       core.setOutput("is-valid", false);
+      core.setOutput("error-message", lengthValidation.message);
       return;
     }
 
@@ -32,6 +33,7 @@ export async function run(): Promise<void> {
     );
     if (!prefixesValidation.isValid) {
       core.setOutput("is-valid", false);
+      core.setOutput("error-message", prefixesValidation.message);
       return;
     }