https://github.com/swissgrc/docker-azure-pipelines-markdownlint

🐳 Docker image for running markdownlint in an Azure Pipelines container job
https://github.com/swissgrc/docker-azure-pipelines-markdownlint

azure-devops azure-pipelines docker hacktoberfest markdownlint

Last synced: 2 months ago
JSON representation

🐳 Docker image for running markdownlint in an Azure Pipelines container job

• Host: GitHub
• URL: https://github.com/swissgrc/docker-azure-pipelines-markdownlint
• Owner: swissgrc
• License: mit
• Created: 2021-02-26T08:21:56.000Z (about 4 years ago)
• Default Branch: develop
• Last Pushed: 2025-02-14T14:19:41.000Z (3 months ago)
• Last Synced: 2025-02-14T15:29:58.392Z (3 months ago)
• Topics: azure-devops, azure-pipelines, docker, hacktoberfest, markdownlint
• Language: Dockerfile
• Homepage: https://hub.docker.com/r/swissgrc/azure-pipelines-markdownlint
• Size: 134 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Docker image for running markdownlint-cli in Azure Pipelines container jobs

[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/swissgrc/docker-azure-pipelines-markdownlint/blob/main/LICENSE) [![Build](https://img.shields.io/github/actions/workflow/status/swissgrc/docker-azure-pipelines-markdownlint/publish.yml?branch=develop&style=flat-square)](https://github.com/swissgrc/docker-azure-pipelines-markdownlint/actions/workflows/publish.yml) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=swissgrc_docker-azure-pipelines-markdownlint&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=swissgrc_docker-azure-pipelines-markdownlint) [![Pulls](https://img.shields.io/docker/pulls/swissgrc/azure-pipelines-markdownlint.svg?style=flat-square)](https://hub.docker.com/r/swissgrc/azure-pipelines-markdownlint) [![Stars](https://img.shields.io/docker/stars/swissgrc/azure-pipelines-markdownlint.svg?style=flat-square)](https://hub.docker.com/r/swissgrc/azure-pipelines-markdownlint)

Docker image to run [markdownlint] commands in [Azure Pipelines container jobs].

## Usage

This container can be used to run markdownlint commands in [Azure Pipelines container jobs].

### Azure Pipelines Container Job

To use the image in an Azure Pipelines Container Job add the following task use it with the `container` property.

The following example shows the container used for linting the repository:

```yaml

- stage: Build

  jobs:

  - job: Lint

    steps:

    - bash: |

        markdownlint --output /markdownlint.json --json --config /.markdownlint.json /docs

      target: swissgrc/azure-pipelines-markdownlint:latest

```

### Included Software

- Node.js

- [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli)

### Tags

| Tag      | Description                                                      | Size                                                                                                                                  |

|----------|------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|

| latest   | Latest stable release (from `main` branch)                       | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/swissgrc/azure-pipelines-markdownlint/latest?style=flat-square)   |

| unstable | Latest unstable release (from `develop` branch)                  | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/swissgrc/azure-pipelines-markdownlint/unstable?style=flat-square) |

| x.y.z    | Image for a specific version of markdownlint-cli                 |                                                                                                                                       |

[markdownlint]: https://github.com/igorshubovych/markdownlint-cli

[Azure Pipelines container jobs]: https://docs.microsoft.com/en-us/azure/devops/pipelines/process/container-phases