diff --git a/README.md b/README.md index 714c662..650a16f 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,25 @@ [![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) [![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) [![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) - [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE) [![GitHub Sponsors](https://img.shields.io/github/sponsors/edumserrano)](https://github.com/sponsors/edumserrano) [![LinkedIn](https://img.shields.io/badge/LinkedIn-Eduardo%20Serrano-blue.svg)](https://www.linkedin.com/in/eduardomserrano/) +- [Description](#description) +- [Usage](#usage) +- [Action inputs](#action-inputs) +- [Action outputs](#action-outputs) +- [Tips](#tips) +- [Examples of the JSON file produced](#examples-of-the-json-file-produced) +- [Examples of the markdown file produced](#examples-of-the-markdown-file-produced) +- [Notes regarding the `Markdown Link Check` log](#notes-regarding-the-markdown-link-check-log) +- [Example usages of this action in GitHub workflows](#example-usages-of-this-action-in-github-workflows) +- [Troubleshooting: I can't figure out the right job name and step name to use](#troubleshooting-i-cant-figure-out-the-right-job-name-and-step-name-to-use) +- [Dev notes](#dev-notes) + +## Description + A Docker container [GitHub action](https://docs.github.com/en/actions/learn-github-actions/finding-and-customizing-actions) that can be used to parse the log from a [GitHub Action - Markdown link check](https://github.com/gaurav-nelson/github-action-markdown-link-check) step. As of writing this, the [GitHub Action - Markdown link check](https://github.com/gaurav-nelson/github-action-markdown-link-check) doesn't provide information from the Markdown link check as output of the action and there's even a long outstanding [open issue about it](https://github.com/gaurav-nelson/github-action-markdown-link-check/issues/9). This action is an alternative solution for that issue. diff --git a/docs/dev-notes/README.md b/docs/dev-notes/README.md index 781bf16..c61fc10 100644 --- a/docs/dev-notes/README.md +++ b/docs/dev-notes/README.md @@ -1,5 +1,21 @@ # Dev notes +- [Building the MarkdownLinkCheckLogParser solution](#building-the-markdownlinkchecklogparser-solution) + - [Building with Visual Studio](#building-with-visual-studio) + - [Building with dotnet CLI](#building-with-dotnet-cli) +- [Running MarkdownLinkCheckLogParser solution tests](#running-markdownlinkchecklogparser-solution-tests) + - [Run tests with Visual Studio](#run-tests-with-visual-studio) + - [Run tests with dotnet CLI](#run-tests-with-dotnet-cli) +- [Building and running the Docker container action](#building-and-running-the-docker-container-action) +- [Projects wide configuration](#projects-wide-configuration) +- [Deterministic Build configuration](#deterministic-build-configuration) +- [Repository configuration](#repository-configuration) +- [GitHub Workflows](#github-workflows) +- [GitHub marketplace](#github-marketplace) +- [Note about the Docker container action](#note-about-the-docker-container-action) + - [As of writing this, the log for building the docker action looks as follows](#as-of-writing-this-the-log-for-building-the-docker-action-looks-as-follows) + - [As of writing this, the log for running the docker action looks as follows](#as-of-writing-this-the-log-for-running-the-docker-action-looks-as-follows) + ## Building the MarkdownLinkCheckLogParser solution ### Building with Visual Studio @@ -36,6 +52,7 @@ The steps below show how to run the Docker container action against a set of tes ``` docker run --rm -v ${pwd}:/workspace --workdir /workspace mlc-log-parser ` +parse-log ` --auth-token ` --repo ` --run-id `