Add test action from GH marketplace and update docs

edumserrano · edumserrano · commit fa10c2c66ab8 · 2023-02-04T20:26:49.000Z
diff --git a/.github/workflows/publish-docker-image.yml b/.github/workflows/publish-docker-image.yml
@@ -4,6 +4,7 @@ on:
   workflow_dispatch:
   push:
     branches: [ main ]
+    tags: [ 'v*' ]
     paths-ignore:
     - "**.md"
   schedule:
@@ -37,6 +38,7 @@ jobs:
         uses: docker/metadata-action@v4
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          flavor: latest=true
       - name: Build and push Docker image
         uses: docker/build-push-action@v4
         with:
diff --git a/.github/workflows/test-action-gh-marketplace.yml b/.github/workflows/test-action-gh-marketplace.yml
@@ -0,0 +1,112 @@
+name: Test GitHub action from GH Marketplace
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ main ]
+    paths-ignore:
+    - "**.md"
+  schedule:
+    - cron: '0 0 * * 0' # Once a week: "At 00:00 on Sunday."
+
+defaults:
+  run:
+    shell: pwsh
+
+jobs:
+  test-success:
+    name: Test success
+    permissions:
+      contents: read
+    runs-on: ubuntu-latest
+    steps:
+    - name: Dump github context for debug purposes
+      env:
+        GITHUB_CONTEXT: ${{ toJSON(github) }}
+      run: $env:GITHUB_CONTEXT
+    - uses: actions/checkout@v3
+    - name: Get test input args
+      id: args
+      run: |
+        $templateFilepath = './GitHubIssueFormsParser/tests/GitHubIssuesParserCli.Tests/TestFiles/Template.yml'
+        # using -Raw is needed or else the newlines are not preserved and the action will fail to parse the body
+        $issueBody = Get-Content ./GitHubIssueFormsParser/tests/GitHubIssuesParserCli.Tests/TestFiles/IssueBody.md -Raw
+        $random = Get-Random
+        $delimiter = "EOF_$random"
+        Write-Output "issue-body<<$delimiter" >> $env:GITHUB_OUTPUT
+        Write-Output $issueBody >> $env:GITHUB_OUTPUT
+        Write-Output $delimiter >> $env:GITHUB_OUTPUT
+        Write-Output "template-filepath=$templateFilepath" >> $env:GITHUB_OUTPUT
+    - name: Dump outputs from previous step
+      env:
+        STEP_OUTPUT: ${{ toJSON(steps.args.outputs) }}
+      run: $env:STEP_OUTPUT
+    - name: Run GitHub issue forms parser
+      id: issue-parser
+      uses: edumserrano/github-issue-forms-parser@v1
+      with:
+        template-filepath: '${{ steps.args.outputs.template-filepath }}'
+        issue-form-body: '${{ steps.args.outputs.issue-body }}'
+    - name: Dump outputs from previous step
+      env:
+        STEP_OUTPUT: ${{ toJSON(steps.issue-parser.outputs) }}
+      run: $env:STEP_OUTPUT
+    - name: Output and assert parsed issue
+      run: |
+        $issue = '${{ steps.issue-parser.outputs.parsed-issue }}' | ConvertFrom-Json
+        $issueAsJsonIndented = ConvertTo-Json $issue
+        $expectedIssueAsJson = '{
+          "nuget-id": "dotnet-sdk-extensions",
+          "nuget-version": "1.0.13-alpha",
+          "auto-generate-release-notes": "Yes",
+          "push-nuget": "",
+          "custom-release-notes": "## Custom release notes\n\nTest 123\n\nAnother line:\n- point 1\n- point 2\n- point 3",
+          "operating-systems": {
+            "macos": true,
+            "windows": true,
+            "linux": false,
+            "i-dont-know": false
+          }
+        }'
+
+        Write-Output $issueAsJsonIndented
+        if($expectedIssueAsJson -eq $issueAsJsonIndented)
+        {
+          Write-Output "::notice title=Action check::Action produced the expected output. See the output from the step 'Output and assert parsed issue'."
+        }
+        else
+        {
+          Write-Output "::error title=Action check::Action didn't produce expected output. See the output from the step 'Output and assert parsed issue'."
+          Exit -1
+        }
+
+  test-failure:
+    name: Test failure
+    permissions:
+      contents: read
+    runs-on: ubuntu-latest
+    steps:
+    - name: Dump github context for debug purposes
+      env:
+        GITHUB_CONTEXT: ${{ toJSON(github) }}
+      run: $env:GITHUB_CONTEXT
+    - uses: actions/checkout@v3
+    - name: Run GitHub issue forms parser with bad input
+      id: issue-parser-bad-input
+      uses: edumserrano/github-issue-forms-parser@v1
+      continue-on-error: true
+      with:
+        template-filepath: '${{ steps.args.outputs.template-filepath }}'
+        issue-form-body: '{}'
+    - name: The action should fail if it fails to parse
+      run: |
+        $parseStepWithBadInputOutcome = '${{ steps.issue-parser-bad-input.outcome }}'
+        if($parseStepWithBadInputOutcome -eq 'success')
+        {
+          Write-Output "::error title=Action check:Action should have failed the workflow because of invalid input but it didn't."
+          Exit 1
+        }
+        else
+        {
+          Write-Output "::notice title=Action check::Action would have failed the workflow given invalid input. You should see an error message on the action's Annotations."
+        }
diff --git a/README.md b/README.md
@@ -2,6 +2,7 @@
 
 [![Build and test](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/build-test.yml/badge.svg)](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/build-test.yml)
 [![Test GitHub action](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/test-action.yml/badge.svg)](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/test-action.yml)
+[![Test GitHub action from GH Marketplace](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/test-action-gh-marketplace.yml/badge.svg)](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/test-action-gh-marketplace.yml)
 [![Publish Docker image](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/publish-docker-image.yml/badge.svg)](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/publish-docker-image.yml)
 [![codecov](https://codecov.io/gh/edumserrano/github-issue-forms-parser/branch/main/graph/badge.svg?token=B9nrGE2Ine)](https://codecov.io/gh/edumserrano/github-issue-forms-parser)
 [![GitHub Marketplace](https://img.shields.io/badge/Marketplace-GitHub%20issue%20forms%20parser-blue.svg?colorA=24292e&colorB=0366d6&style=flat&longCache=true&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAM6wAADOsB5dZE0gAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAERSURBVCiRhZG/SsMxFEZPfsVJ61jbxaF0cRQRcRJ9hlYn30IHN/+9iquDCOIsblIrOjqKgy5aKoJQj4O3EEtbPwhJbr6Te28CmdSKeqzeqr0YbfVIrTBKakvtOl5dtTkK+v4HfA9PEyBFCY9AGVgCBLaBp1jPAyfAJ/AAdIEG0dNAiyP7+K1qIfMdonZic6+WJoBJvQlvuwDqcXadUuqPA1NKAlexbRTAIMvMOCjTbMwl1LtI/6KWJ5Q6rT6Ht1MA58AX8Apcqqt5r2qhrgAXQC3CZ6i1+KMd9TRu3MvA3aH/fFPnBodb6oe6HM8+lYHrGdRXW8M9bMZtPXUji69lmf5Cmamq7quNLFZXD9Rq7v0Bpc1o/tp0fisAAAAASUVORK5CYII=)](https://github.com/marketplace/actions/github-issue-forms-parser)
diff --git a/action.yml b/action.yml
@@ -15,7 +15,7 @@ outputs:
     description: 'The parsed issue form as a JSON string.'
 runs:
   using: 'docker'
-  image: 'docker://ghcr.io/edumserrano/github-issue-forms-parser:main'
+  image: 'docker://ghcr.io/edumserrano/github-issue-forms-parser:v1'
   args:
     - parse-issue-form
     - --template-filepath
diff --git a/docs/dev-notes/README.md b/docs/dev-notes/README.md
@@ -69,13 +69,17 @@ To pass arguments to the app when debugging you can use the `commandLineArgs` in
 The steps below show how to run the Docker container action against a set of test data provided by the repo. However you can follow the same steps and provide any data you wish to test.
 
 1) Clone the repo and browse to the repo's directory.
-2) Run `docker build -t github-issue-parser .`
-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:
+2) Create an empty file named `github-step-output.txt` that will store the GitHub step output of the action. To create an empty file you can do something like `echo $null >> github-step-output.txt`.
+3) Run `docker build -t github-issue-parser .`
+4) Read the test issue form body into the variable `$issueBody` by doing: `$issueBody = Get-Content GitHubIssueFormsParser/tests/GitHubIssuesParserCli.Tests/TestFiles/IssueBody.md -Raw`
+5) Run the docker container by executing:
 
 ```
-docker run --rm -v ${pwd}:/workspace --workdir /workspace github-issue-parser `
-parse-issue-form `
+docker run --env GITHUB_OUTPUT=/workspace/github-step-output.txt `
+-v ${pwd}:/workspace `
+-v ${pwd}/github-step-output.txt:/workspace/github-step-output.txt `
+--workdir /workspace `
+github-issue-parser parse-issue-form `
 --template-filepath GitHubIssueFormsParser/tests/GitHubIssuesParserCli.Tests/TestFiles/Template.yml `
 --issue-body $issueBody
 ```
@@ -126,6 +130,12 @@ To understand better how the action builds and executes the Docker container loo
 
 ### As of writing this, the log for building the docker action looks as follows
 
+> **Note**
+>
+> This is the log when building the docker image for the action, which only happens on the [test-action workflow](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/test-action.yml) because using the published action from GitHub Marketplace will download the package from the GitHub packages and so the log will look different.
+>
+> The information mentioned here is still valuable to understand more about how GitHub Docker actions work.
+
 ```
 /usr/bin/docker build
 -t 2bcf09:d996dfb6f4ec40c1a59c1e244bdd3374
@@ -145,6 +155,12 @@ This way it can successfully build the Dockerfile for this action which would ot
 
 ### As of writing this, the log for running the docker action looks as follows
 
+> **Note**
+>
+> This is the log when building the docker image for the action, which only happens on the [test-action workflow](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/test-action.yml) because using the published action from GitHub Marketplace will download the package from the GitHub packages and so the log will look different.
+>
+> The information mentioned here is still valuable to understand more about how GitHub Docker actions work.
+
 ```
 /usr/bin/docker run
 --name bcf09d996dfb6f4ec40c1a59c1e244bdd3374_381201
diff --git a/docs/dev-notes/workflows/README.md b/docs/dev-notes/workflows/README.md
@@ -2,16 +2,18 @@
 
 There are two workflows setup on this repo:
 
-| Worflow                                                                     | Status and link                                                                                                                                                                                                                                           |                            Description                             |
-| --------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------: |
-| [build-and-test](/.github/workflows/build-test.yml)                         | [![Build and test](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/build-test.yml/badge.svg)](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/build-test.yml)                                       |                 Builds the solution and runs tests                 |
-| [test-action](/.github/workflows/test-action.yml)                           | [![Test GitHub action](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/test-action.yml/badge.svg)](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/test-action.yml)                                 |                 Builds and tests the GitHub action                 |
-| [publish-docker-image](/.github/workflows/publish-docker-image.yml)         | [![Publish Docker image](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/publish-docker-image.yml/badge.svg)](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/publish-docker-image.yml)             |   Publishes Docker image used by this action to GitHub packages    |
-| [package-retention-policy](/.github/workflows/package-retention-policy.yml) | [![Package retention policy](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/package-retention-policy.yml/badge.svg)](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/package-retention-policy.yml) | Removes old Docker images used by this action from GitHub packages |
+| Worflow                                                                         | Status and link                                                                                                                                                                                                                                                             | Description                                                                           |
+| ------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------ |
+| [build-and-test](/.github/workflows/build-test.yml)                             | [![Build and test](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/build-test.yml/badge.svg)](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/build-test.yml)                                                         | Builds the solution and runs tests                                                    |
+| [test-action](/.github/workflows/test-action.yml)                               | [![Test GitHub action](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/test-action.yml/badge.svg)](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/test-action.yml)                                                   | Builds and tests the GitHub action. Builds the action from this repo.                 |
+| [test-action-gh-marketplace](/.github/workflows/test-action-gh-marketplace.yml) | [![Test GitHub action from GH Marketplace](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/test-action-gh-marketplace.yml/badge.svg)](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/test-action-gh-marketplace.yml) | Builds and tests the GitHub action. Uses the published version to GitHub Marketplace. |
+| [publish-docker-image](/.github/workflows/publish-docker-image.yml)             | [![Publish Docker image](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/publish-docker-image.yml/badge.svg)](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/publish-docker-image.yml)                               | Publishes Docker image used by this action to GitHub packages                         |
+| [package-retention-policy](/.github/workflows/package-retention-policy.yml)     | [![Package retention policy](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/package-retention-policy.yml/badge.svg)](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/package-retention-policy.yml)                   | Removes old Docker images used by this action from GitHub packages                    |
 
 ## Workflows' documentation
 
 - [build-and-test](/docs/dev-notes/workflows/build-and-test-workflow.md)
 - [test-action](/docs/dev-notes/workflows/test-action-workflow.md)
+- [test-action-gh-marketplace](/docs/dev-notes/workflows/test-action-gh-marketplace-workflow.md)
 - [publish-docker-image](/docs/dev-notes/workflows/publish-docker-image.md)
 - [package-retention-policy](/docs/dev-notes/workflows/package-retention-policy.md)
diff --git a/docs/dev-notes/workflows/test-action-gh-marketplace-workflow.md b/docs/dev-notes/workflows/test-action-gh-marketplace-workflow.md
@@ -0,0 +1,11 @@
+# test-action workflow
+
+[![Test GitHub action from GH Marketplace](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/test-action-gh-marketplace.yml/badge.svg)](https://github.com/edumserrano/github-issue-forms-parser/actions/workflows/test-action-gh-marketplace.yml)
+
+[This workflow](/.github/workflows/test-action-gh-marketplace.yml):
+
+- Is a copy of the [test-action workflow](/.github/workflows/test-action.yml). See the [documentation for that workflow](/docs/dev-notes/workflows/test-action-workflow.md) for more info.
+- The main difference from this workflow and the `test-action workflow` are:
+  - Tests the GitHub action from the Marketplace instead of building it from this repo. It makes sure that the published version is working.
+  - Does not run against PRs because it shouldn't add a status check to PRs.
+
diff --git a/entrypoint.ps1 b/entrypoint.ps1
@@ -7,7 +7,6 @@ function Main()
   Write-Output $inputArgs
   Write-Output "::endgroup::"
 
-  Write-Output "::group::Run dotnet GitHub issue form parser"
   $output = dotnet '/app/GitHubIssuesParserCli.dll' $inputArgs
   if ($LASTEXITCODE -ne 0 )
   {
@@ -20,13 +19,12 @@ function Main()
   Write-Output "parsed-issue<<$delimiter" >> $env:GITHUB_OUTPUT
   Write-Output $output >> $env:GITHUB_OUTPUT
   Write-Output $delimiter >> $env:GITHUB_OUTPUT
-  Write-Output "::endgroup::"
 
-  Write-Output "::group::dotnet GitHub issue form parser output"
+  Write-Output "::group::GitHub issue form parser output"
   Write-Output $output
   Write-Output "::endgroup::"
 
-  Write-Output "::group::dotnet GitHub issue form parser output indented"
+  Write-Output "::group::GitHub issue form parser output indented"
   $outputAsJson = ConvertFrom-Json $output
   COnvertTo-Json $outputAsJson
   Write-Output "::endgroup::"
