Make step fail if parsing fails and fix usage of "form" vs "forms"

Author: edumserrano

GitHubIssueFormsParser/src/GitHubIssuesParserCli/CliCommands/ParseGitHubIssueFormCommandException.cs

@@ -2,7 +2,7 @@ namespace GitHubIssuesParserCli.CliCommands;
 
 public class ParseGitHubIssueFormCommandException : Exception
 {
-    private const string _errorMessage = "An error occurred trying to execute the command to parse a GitHub issue forms. See inner exception for more details.";
+    private const string _errorMessage = "An error occurred trying to execute the command to parse a GitHub issue form. See inner exception for more details.";
 
     public ParseGitHubIssueFormCommandException(Exception innerException)
        : base(_errorMessage, innerException)

GitHubIssueFormsParser/src/GitHubIssuesParserCli/CliCommands/ParseIssueFormCommand.cs

@@ -3,10 +3,10 @@ namespace GitHubIssuesParserCli.CliCommands;
 [Command("parse-issue-form")]
 public class ParseIssueFormCommand : ICommand
 {
-    [CommandOption("issue-body", 'i', Description = "The body of the GitHub issue forms.")]
+    [CommandOption("issue-body", 'i', Description = "The body of the GitHub issue form.")]
     public string? IssueFormBody { get; init; }
 
-    [CommandOption("template-filepath", 't', Description = "The filepath for the GitHub issue forms YAML template.")]
+    [CommandOption("template-filepath", 't', Description = "The filepath for the GitHub issue form YAML template.")]
     public string? TemplateFilepath { get; init; }
 
     public async ValueTask ExecuteAsync(IConsole console)

GitHubIssueFormsParser/src/GitHubIssuesParserCli/IssueFormBody/Parsing/IssueFormBodyParserException.cs

@@ -9,7 +9,7 @@ private IssueFormBodyParserException(string message)
 
     internal static IssueFormBodyParserException H3HeaderNotFound(string h3Header)
     {
-        var message = $"H3 header value '{h3Header}' not found in issue forms body.";
+        var message = $"H3 header value '{h3Header}' not found in issue form body.";
         return new IssueFormBodyParserException(message);
     }
 

GitHubIssueFormsParser/src/GitHubIssuesParserCli/IssueFormTemplates/Parsing/IssueFormYamlTemplateParser.cs

@@ -14,9 +14,9 @@ public static IssueFormYamlTemplate Parse(IssueFormYamlTemplateText yamlTemplate
             throw IssueFormYamlTemplateParserException.InvalidYmlTemplate();
         }
 
-        // markdown template item types do NOT show in the issue forms body, they are only used
+        // markdown template item types do NOT show in the issue form body, they are only used
         // to show some markdown text when creating the issue. Excluding them here so that we
-        // only get the issue forms template items that will be rendered on the issue forms body
+        // only get the issue form template items that will be rendered on the issue form body
         var items = templateDto.Body
             .Where(x => x.Type is not IssueFormYamlTemplateItemDtoTypes.Markdown)
             .Select(x =>

GitHubIssueFormsParser/src/GitHubIssuesParserCli/IssueFormTemplates/Parsing/IssueFormYamlTemplateParserException.cs

@@ -9,7 +9,7 @@ private IssueFormYamlTemplateParserException(string message)
 
     internal static IssueFormYamlTemplateParserException InvalidYmlTemplate()
     {
-        const string message = "Failed to deserialize the issue forms template. The template must contain at least an YAML member named 'body' at the first indentation level.";
+        const string message = "Failed to deserialize the issue form template. The template must contain at least an YAML member named 'body' at the first indentation level.";
         return new IssueFormYamlTemplateParserException(message);
     }
 

GitHubIssueFormsParser/tests/GitHubIssuesParserCli.Tests/CliCommands/ParseIssueFormCommandValidationTests.cs

@@ -18,7 +18,7 @@ public async Task ValidateIssueFormBodyParam(string? issueFormBody)
             TemplateFilepath = "./some/file/path.txt",
         };
         var exception = await Should.ThrowAsync<ParseGitHubIssueFormCommandException>(() => command.ExecuteAsync(console).AsTask());
-        exception.Message.ShouldBe("An error occurred trying to execute the command to parse a GitHub issue forms. See inner exception for more details.");
+        exception.Message.ShouldBe("An error occurred trying to execute the command to parse a GitHub issue form. See inner exception for more details.");
         exception.InnerException.ShouldNotBeNull();
         exception.InnerException.ShouldBeAssignableTo<ArgumentException>();
         exception.InnerException.Message.ShouldBe("IssueFormBody cannot be null or whitespace.");
@@ -35,11 +35,11 @@ public async Task ValidateTemplateFilepathParam(string? templateFilepath)
         using var console = new FakeInMemoryConsole();
         var command = new ParseIssueFormCommand
         {
-            IssueFormBody = "some issue forms body",
+            IssueFormBody = "some issue form body",
             TemplateFilepath = templateFilepath,
         };
         var exception = await Should.ThrowAsync<ParseGitHubIssueFormCommandException>(() => command.ExecuteAsync(console).AsTask());
-        exception.Message.ShouldBe("An error occurred trying to execute the command to parse a GitHub issue forms. See inner exception for more details.");
+        exception.Message.ShouldBe("An error occurred trying to execute the command to parse a GitHub issue form. See inner exception for more details.");
         exception.InnerException.ShouldNotBeNull();
         exception.InnerException.ShouldBeAssignableTo<ArgumentException>();
         exception.InnerException.Message.ShouldBe("TemplateFilepath cannot be null or whitespace.");
@@ -55,11 +55,11 @@ public async Task TemplateFilepathNotFound()
         using var console = new FakeInMemoryConsole();
         var command = new ParseIssueFormCommand
         {
-            IssueFormBody = "some issue forms body",
+            IssueFormBody = "some issue form body",
             TemplateFilepath = "./this/path/does/not/exist.yml",
         };
         var exception = await Should.ThrowAsync<ParseGitHubIssueFormCommandException>(() => command.ExecuteAsync(console).AsTask());
-        exception.Message.ShouldBe("An error occurred trying to execute the command to parse a GitHub issue forms. See inner exception for more details.");
+        exception.Message.ShouldBe("An error occurred trying to execute the command to parse a GitHub issue form. See inner exception for more details.");
         exception.InnerException.ShouldNotBeNull();
         exception.InnerException.ShouldBeAssignableTo<DirectoryNotFoundException>();
         exception.InnerException.Message.ShouldStartWith("Could not find a part of the path");
@@ -75,14 +75,14 @@ public async Task InvalidTemplate()
         using var console = new FakeInMemoryConsole();
         var command = new ParseIssueFormCommand
         {
-            IssueFormBody = "some issue forms body",
+            IssueFormBody = "some issue form body",
             TemplateFilepath = "./TestFiles/InvalidTemplate.yml",
         };
         var exception = await Should.ThrowAsync<ParseGitHubIssueFormCommandException>(() => command.ExecuteAsync(console).AsTask());
-        exception.Message.ShouldBe("An error occurred trying to execute the command to parse a GitHub issue forms. See inner exception for more details.");
+        exception.Message.ShouldBe("An error occurred trying to execute the command to parse a GitHub issue form. See inner exception for more details.");
         exception.InnerException.ShouldNotBeNull();
         exception.InnerException.ShouldBeAssignableTo<IssueFormYamlTemplateParserException>();
-        exception.InnerException.Message.ShouldStartWith("Failed to deserialize the issue forms template. The template must contain at least an YAML member named 'body' at the first indentation level.");
+        exception.InnerException.Message.ShouldStartWith("Failed to deserialize the issue form template. The template must contain at least an YAML member named 'body' at the first indentation level.");
     }
 
     /// <summary>
@@ -99,10 +99,10 @@ public async Task InvalidIssueFormBody()
             TemplateFilepath = "./TestFiles/Template.yml",
         };
         var exception = await Should.ThrowAsync<ParseGitHubIssueFormCommandException>(() => command.ExecuteAsync(console).AsTask());
-        exception.Message.ShouldBe("An error occurred trying to execute the command to parse a GitHub issue forms. See inner exception for more details.");
+        exception.Message.ShouldBe("An error occurred trying to execute the command to parse a GitHub issue form. See inner exception for more details.");
         exception.InnerException.ShouldNotBeNull();
         exception.InnerException.ShouldBeAssignableTo<IssueFormBodyParserException>();
-        exception.InnerException.Message.ShouldStartWith("H3 header value '### What NuGet package do you want to release?' not found in issue forms body.");
+        exception.InnerException.Message.ShouldStartWith("H3 header value '### What NuGet package do you want to release?' not found in issue form body.");
     }
 
     /// <summary>
@@ -119,7 +119,7 @@ public async Task InvalidIssueFormBody2()
             TemplateFilepath = "./TestFiles/Template.yml",
         };
         var exception = await Should.ThrowAsync<ParseGitHubIssueFormCommandException>(() => command.ExecuteAsync(console).AsTask());
-        exception.Message.ShouldBe("An error occurred trying to execute the command to parse a GitHub issue forms. See inner exception for more details.");
+        exception.Message.ShouldBe("An error occurred trying to execute the command to parse a GitHub issue form. See inner exception for more details.");
         exception.InnerException.ShouldNotBeNull();
         exception.InnerException.ShouldBeAssignableTo<IssueFormBodyParserException>();
         exception.InnerException.Message.ShouldStartWith("Failed to obtain the value for H3 header: '### What NuGet package do you want to release?'. Couldn't find any text between that H3 header and the next H3 header: '### What is the new version for the NuGet package?'.");
@@ -139,7 +139,7 @@ public async Task InvalidIssueFormBody3()
             TemplateFilepath = "./TestFiles/Template.yml",
         };
         var exception = await Should.ThrowAsync<ParseGitHubIssueFormCommandException>(() => command.ExecuteAsync(console).AsTask());
-        exception.Message.ShouldBe("An error occurred trying to execute the command to parse a GitHub issue forms. See inner exception for more details.");
+        exception.Message.ShouldBe("An error occurred trying to execute the command to parse a GitHub issue form. See inner exception for more details.");
         exception.InnerException.ShouldNotBeNull();
         exception.InnerException.ShouldBeAssignableTo<IssueFormBodyParserException>();
         exception.InnerException.Message.ShouldStartWith("Invalid checkbox option text: '- macOS'.");

README.md

@@ -38,25 +38,25 @@ A Docker container [GitHub action](https://docs.github.com/en/actions/learn-gith
 
 | Name | Description
 | --- | --- |
-| `template-filepath` | The filepath to the [issue forms template](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms). |
+| `template-filepath` | The filepath to the [issue form template](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms). |
 | `issue-form-body` | The body of the issue to parse. |
 
 ### Action outputs
 
 | Name | Description
 | --- | --- |
-| `parsed-issue` | The issue forms parsed as a JSON string. |
+| `parsed-issue` | The issue form parsed as a JSON string. |
 
 **Notes about the JSON output:**
 
 - The keys on the JSON object are id field of the template form element.
 - Checkboxes form elements are outputed as an object whose keys are the [slugified]((https://blog.tersmitten.nl/slugify/)) value of the label of the option.
-- When the form element is optional and no input is provided for the form element then the issue forms body will contain a `_No response_` but the parsed output for that key in the JSON string will just be an empty value.
+- When the form element is optional and no input is provided for the form element then the issue form body will contain a `_No response_` but the parsed output for that key in the JSON string will just be an empty value.
 - **For a better understanding of the output rules see example below.**
 
-## Example output for a given issue forms template and body
+## Example output for a given issue form template and body
 
-Given the following issue forms template:
+Given the following issue form template:
 
 ```yml
 name: Release NuGet package
@@ -120,7 +120,7 @@ body:
         - label: Linux
 ```
 
-And given the following issue forms body:
+And given the following issue form body:
 
 ```md
 ### What NuGet package do you want to release?
@@ -180,7 +180,7 @@ The output would be:
 
 You can check the structure of the action's output on the log produced by the action. 
 
-In the log for the action, expand the groups for `dotnet GitHub issue forms parser output` and `dotnet GitHub issue forms parser output indented` as shown in the image below.
+In the log for the action, expand the groups for `dotnet GitHub issue form parser output` and `dotnet GitHub issue form parser output indented` as shown in the image below.
 
 ![debug-output](docs/readme-images/debug-output.png "Debug output")
 

action.yml

@@ -1,18 +1,18 @@
 name: 'GitHub issue forms parser'
-description: 'Parses a GitHub issue forms body and outputs a JSON representation.'
+description: 'Parses a GitHub issue form body and outputs a JSON representation.'
 branding:
   icon: align-justify
   color: blue
 inputs:
   template-filepath:
-    description: 'The filepath for the GitHub issue forms template.'
+    description: 'The filepath for the GitHub issue form template.'
     required: true
   issue-form-body:
-    description: 'The issue forms body.'
+    description: 'The issue form body.'
     required: true
 outputs:
   parsed-issue:
-    description: 'The parsed issue forms as a JSON string.'
+    description: 'The parsed issue form as a JSON string.'
 runs:
   using: 'docker'
   image: 'Dockerfile'

docs/dev-notes/README.md

@@ -32,16 +32,16 @@ The steps below show how to run the Docker container action against a set of tes
 
 1) Clone the repo and browse to the repo's directory.
 2) Run `docker build -t github-issue-parser .`
-3) Read the test issue forms body into the variable `$issueBody` by doing: `$issueBody = Get-Content GitHubIssueFormsParser/tests/GitHubIssuesParserCli.Tests/TestFiles/IssueBody.md -Raw`
+3) Read the test issue form body into the variable `$issueBody` by doing: `$issueBody = Get-Content GitHubIssueFormsParser/tests/GitHubIssuesParserCli.Tests/TestFiles/IssueBody.md -Raw`
 4) Run the docker container by executing `docker run --rm -v ${pwd}:/workspace --workdir /workspace github-issue-parser GitHubIssueFormsParser/tests/GitHubIssuesParserCli.Tests/TestFiles/Template.yml $issueBody`.
 
 **Notes:**
 
 - The docker container entrypoint expects two arguments:
-    1) First, the filepath to the issue forms template.
-    2) Second, the issue forms body.
-- When running the docker container the current directory is mounted to the docker container so that we can read the issue forms template.
-- When reading the issue forms body into the `$issueBody` variable we have to use the `-Raw` parameter to avoid problems with line endings.
+    1) First, the filepath to the issue form template.
+    2) Second, the issue form body.
+- When running the docker container the current directory is mounted to the docker container so that we can read the issue form template.
+- When reading the issue form body into the `$issueBody` variable we have to use the `-Raw` parameter to avoid problems with line endings.
 
 ## Projects wide configuration
 
@@ -73,7 +73,9 @@ This action is published to the [GitHub marketplace](https://github.com/marketpl
 
 ## Note about the Docker container action
 
-This repo provides a [Docker container action](https://docs.github.com/en/actions/creating-actions/creating-a-docker-container-action). See here for more information about the [syntax for a Docker container action](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs-for-docker-container-actions). To understand better how the action builds and executes the Docker container look at the log for the steps that build and run the action.
+This repo provides a [Docker container action](https://docs.github.com/en/actions/creating-actions/creating-a-docker-container-action). If parsing the GitHub issue form fails then the action [will fail](https://docs.github.com/en/enterprise-cloud@latest/actions/creating-actions/setting-exit-codes-for-actions#setting-a-failure-exit-code-in-a-docker-container-action). See here for more information about the [syntax for a Docker container action](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs-for-docker-container-actions).
+
+To understand better how the action builds and executes the Docker container look at the log for the steps that build and run the action.
 
 ### As of writing this, the log for building the docker action looks as follows
 
@@ -130,19 +132,19 @@ This allows the GitHub action to access the files checked out by the workflow an
 
 **Example:**
 
-- Repository `hello-world` has an issue forms template file at `.github\ISSUE_TEMPLATE\my-template.yml`.
+- Repository `hello-world` has an issue form template file at `.github\ISSUE_TEMPLATE\my-template.yml`.
 - We create a workflow in the `hello-world` repository that checks out the `hello-world` repo and makes use of the `GitHub issue forms parser` action.
 - We set the `template-filepath` input parameter of the `GitHub issue forms parser` action to `.github\ISSUE_TEMPLATE\my-template.yml`.
 - When the workflow is executing the Docker container is able to get to `.github\ISSUE_TEMPLATE\my-template.yml` because the contents of the checked out `hello-world` repo are mounted into the Docker container at `/github/workspace`. Furthermore the `template-filepath` input parameter doesn't need to start with `/github/workspace` because the `workdir` parameter is set to `/github/workspace` when executing the Docker container.
 
 ## Other notes
 
-When creatng the [Test GitHub action workflow](/.github/workflows/test-action.yml) I had difficulty figuring out how to properly read the issue forms body from a file and pass it into the GitHub action as an input parameter.
+When creatng the [Test GitHub action workflow](/.github/workflows/test-action.yml) I had difficulty figuring out how to properly read the issue form body from a file and pass it into the GitHub action as an input parameter.
 
-What was happening initially was that the newlines were not being preserved and the action would fail to parse the issue forms body. To help me debug this issue and see exactly what text, including newline characters, were being passed into the action I added the following debug step:
+What was happening initially was that the newlines were not being preserved and the action would fail to parse the issue form body. To help me debug this issue and see exactly what text, including newline characters, were being passed into the action I added the following debug step:
 
 ```yml
-- name: Debug reading issue forms body file using -Raw
+- name: Debug reading issue form body file using -Raw
   run: |
     $issueBody = Get-Content ./GitHubIssueFormsParser/tests/GitHubIssuesParserCli.Tests/TestFiles/IssueBody.md -Raw
     $issue = @{

docs/dev-notes/workflows/test-action-workflow.md

@@ -5,7 +5,7 @@
 [This workflow](/.github/workflows/test-action.yml):
 
 - Contains a step that executes the GitHub action provided by this repo.
-- Runs the action against a test template and a test issue forms body.
+- Runs the action against a test template and a test issue form body.
 - Checks that the output produced by the action is as expected.
 
 Since this workflow executes the [Docker container action](https://docs.github.com/en/actions/creating-actions/creating-a-docker-container-action) it will build and execute the docker container so if there are any issues with the action's [Dockerfile](/Dockerfile) this workflow will detect it.