Skip to content

Commit 2b1b030

Browse files
committed
update docs and action log output
1 parent a48b251 commit 2b1b030

File tree

3 files changed

+9
-4
lines changed

3 files changed

+9
-4
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[![Build and test](https://github.com/edumserrano/markdown-link-check-log-parser/actions/workflows/build-test.yml/badge.svg)](https://github.com/edumserrano/markdown-link-check-log-parser/actions/workflows/build-test.yml)
44
[![Test GitHub action](https://github.com/edumserrano/markdown-link-check-log-parser/actions/workflows/test-action.yml/badge.svg)](https://github.com/edumserrano/markdown-link-check-log-parser/actions/workflows/test-action.yml)
55
[![Test GitHub action from GH Marketplace](https://github.com/edumserrano/markdown-link-check-log-parser/actions/workflows/test-action-gh-marketplace.yml/badge.svg)](https://github.com/edumserrano/markdown-link-check-log-parser/actions/workflows/test-action-gh-marketplace.yml)
6+
[![Publish Docker image](https://github.com/edumserrano/markdown-link-check-log-parser/actions/workflows/publish-docker-image.yml/badge.svg)](https://github.com/edumserrano/markdown-link-check-log-parser/actions/workflows/publish-docker-image.yml)
67
[![codecov](https://codecov.io/gh/edumserrano/markdown-link-check-log-parser/branch/main/graph/badge.svg?token=4gWKUGwz7V)](https://codecov.io/gh/edumserrano/markdown-link-check-log-parser)
78
[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-Markdown%20Link%20Check%20log%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/markdown-link-check-log-parser)
89

docs/dev-notes/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ The steps below show how to run the Docker container action against a set of tes
5555
docker run --rm --env GITHUB_OUTPUT=/workspace/github-step-output.txt `
5656
-v ${pwd}:/workspace `
5757
-v ${pwd}/github-step-output.txt:/workspace/github-step-output.txt `
58-
--workdir /workspace mlc-log-parser `
59-
parse-log `
58+
--workdir /workspace `
59+
mlc-log-parser parse-log `
6060
--auth-token <github token> `
6161
--repo <repo> `
6262
--run-id <run id> `
@@ -113,7 +113,7 @@ To understand better how the action builds and executes the Docker container loo
113113

114114
> **Note**
115115
>
116-
> This is the log when building the docker image for the action, which only happens on the [test-action workflow](https://github.com/edumserrano/markdown-link-check-log-parser/actions/workflows/test-action.yml) because the log for the action when it's published to the GitHub Marketplace will download the published packaged from the GitHub packages.
116+
> This is the log when building the docker image for the action, which only happens on the [test-action workflow](https://github.com/edumserrano/markdown-link-check-log-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.
117117
>
118118
> The information mentioned here is still valuable to understand more about how GitHub Docker actions work.
119119
@@ -138,7 +138,7 @@ This way it can successfully build the Dockerfile for this action which would ot
138138

139139
> **Note**
140140
>
141-
> This is the log when building the docker image for the action, which only happens on the [test-action workflow](https://github.com/edumserrano/markdown-link-check-log-parser/actions/workflows/test-action.yml) because the log for the action when it's published to the GitHub Marketplace will download the published packaged from the GitHub packages.
141+
> This is the log when building the docker image for the action, which only happens on the [test-action workflow](https://github.com/edumserrano/markdown-link-check-log-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.
142142
>
143143
> The information mentioned here is still valuable to understand more about how GitHub Docker actions work.
144144

entrypoint.ps1

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@ function Main()
2828
Write-Output "mlc-result<<$delimiter" >> $env:GITHUB_OUTPUT
2929
Write-Output $output >> $env:GITHUB_OUTPUT
3030
Write-Output $delimiter >> $env:GITHUB_OUTPUT
31+
32+
Write-Output "::group::Markdown link check log parser output"
33+
Write-Output $output
34+
Write-Output "::endgroup::"
3135
}
3236

3337
# invoke entrypoint function

0 commit comments

Comments
 (0)