Initial Commit

.dockerignore

@@ -0,0 +1 @@
+*

.drone.yml

@@ -0,0 +1,230 @@
+---
+kind: pipeline
+type: kubernetes
+name: linter
+
+platform:
+  os: linux
+  arch: amd64
+
+steps:
+- name: markdown lint
+  commands:
+  - markdownlint *.md
+  image: docker.io/tmknom/markdownlint:0.23.1
+  resources:
+    limits:
+      cpu: 50
+      memory: 50M
+
+- name: email-notification
+  environment:
+    PLUGIN_HOST:
+      from_secret: smtp_host
+    PLUGIN_USERNAME:
+      from_secret: smtp_username
+    PLUGIN_PASSWORD:
+      from_secret: smtp_password
+    PLUGIN_FROM:
+      from_secret: smtp_mail_address
+  image: docker.io/drillster/drone-email:latest
+  resources:
+    limits:
+      cpu: 50
+      memory: 25M
+  when:
+    status:
+    - changed
+    - failure
+
+trigger:
+  event:
+    exclude:
+    - tag
+---
+kind: pipeline
+type: docker
+name: latest-amd64
+
+platform:
+  os: linux
+  arch: amd64
+
+steps:
+- name: build
+  image: plugins/docker
+  settings:
+    dockerfile: Dockerfile
+    auto_tag: true
+    tags: latest-amd64
+    repo: volkerraschek/markdownlint
+    username:
+      from_secret: container_image_registry_user
+    password:
+      from_secret: container_image_registry_password
+  volumes:
+  - name: docker_socket
+    path: /var/run/docker.sock
+  when:
+    branch:
+    - master
+
+- name: notify
+  image: drillster/drone-email
+  environment:
+    PLUGIN_HOST:
+      from_secret: smtp_host
+    PLUGIN_USERNAME:
+      from_secret: smtp_username
+    PLUGIN_PASSWORD:
+      from_secret: smtp_password
+    PLUGIN_FROM:
+      from_secret: smtp_mail_address
+  when:
+    status:
+    - changed
+    - failure
+
+volumes:
+- name: docker_socket
+  host:
+    path: /var/run/docker.sock
+
+---
+kind: pipeline
+type: docker
+name: latest-armv7
+
+platform:
+  os: linux
+  arch: arm
+
+steps:
+- name: build
+  image: plugins/docker
+  settings:
+    dockerfile: Dockerfile
+    auto_tag: true
+    tags: latest-armv7
+    repo: volkerraschek/markdownlint
+    username:
+      from_secret: container_image_registry_user
+    password:
+      from_secret: container_image_registry_password
+  when:
+    branch:
+    - master
+
+- name: notify
+  image: drillster/drone-email
+  environment:
+    PLUGIN_HOST:
+      from_secret: smtp_host
+    PLUGIN_USERNAME:
+      from_secret: smtp_username
+    PLUGIN_PASSWORD:
+      from_secret: smtp_password
+    PLUGIN_FROM:
+      from_secret: smtp_mail_address
+  volumes:
+  - name: docker_socket
+    path: /var/run/docker.sock
+  when:
+    status:
+    - changed
+    - failure
+
+volumes:
+- name: docker_socket
+  host:
+    path: /var/run/docker.sock
+
+---
+kind: pipeline
+type: kubernetes
+name: latest-manifest
+
+steps:
+- name: build-manifest
+  image: plugins/manifest
+  settings:
+    auto_tag: true
+    ignore_missing: true
+    spec: manifest.tmpl
+    username:
+      from_secret: container_image_registry_user
+    password:
+      from_secret: container_image_registry_password
+
+- name: notify
+  image: docker.io/drillster/drone-email:latest
+  environment:
+    PLUGIN_HOST:
+      from_secret: smtp_host
+    PLUGIN_USERNAME:
+      from_secret: smtp_username
+    PLUGIN_PASSWORD:
+      from_secret: smtp_password
+    PLUGIN_FROM:
+      from_secret: smtp_mail_address
+  resources:
+    limits:
+      cpu: 50
+      memory: 25M
+  when:
+    status:
+    - changed
+    - failure
+
+depends_on:
+- latest-amd64
+- latest-armv7
+
+---
+kind: pipeline
+type: kubernetes
+name: sync
+
+platform:
+  os: linux
+  arch: amd64
+
+steps:
+- name: github
+  image: docker.io/appleboy/drone-git-push:latest
+  resources:
+    limits:
+      cpu: 50
+      memory: 25M
+  settings:
+    branch: master
+    remote: ssh://git@github.com/volker-raschek/markdownlint-docker.git
+    force: true
+    ssh_key:
+      from_secret: ssh_key
+
+- name: email-notification
+  environment:
+    PLUGIN_HOST:
+      from_secret: smtp_host
+    PLUGIN_USERNAME:
+      from_secret: smtp_username
+    PLUGIN_PASSWORD:
+      from_secret: smtp_password
+    PLUGIN_FROM:
+      from_secret: smtp_mail_address
+  image: docker.io/drillster/drone-email:latest
+  resources:
+    limits:
+      cpu: 50
+      memory: 25M
+  when:
+    status:
+    - changed
+    - failure
+
+trigger:
+  event:
+  - push
+  repo:
+  - volker.raschek/markdownlint-docker

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = false
+
+[Makefile]
+indent_style = tab

.gitattributes

@@ -0,0 +1 @@
+Makefile eol=lf

.gitignore

@@ -0,0 +1,2 @@
+# IntelliJ
+.idea/

.markdownlint.yaml

@@ -0,0 +1,144 @@
+# markdownlint YAML configuration
+# https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
+
+# Default state for all rules
+default: true
+
+# Path to configuration file to extend
+extends: null
+
+# MD003/heading-style/header-style - Heading style
+MD003:
+  # Heading style
+  style: "atx"
+
+# MD004/ul-style - Unordered list style
+MD004:
+  style: "dash"
+
+# MD007/ul-indent - Unordered list indentation
+MD007:
+  # Spaces for indent
+  indent: 2
+  # Whether to indent the first level of the list
+  start_indented: false
+
+# MD009/no-trailing-spaces - Trailing spaces
+MD009:
+  # Spaces for line break
+  br_spaces: 2
+  # Allow spaces for empty lines in list items
+  list_item_empty_lines: false
+  # Include unnecessary breaks
+  strict: false
+
+# MD010/no-hard-tabs - Hard tabs
+MD010:
+  # Include code blocks
+  code_blocks: true
+
+# MD012/no-multiple-blanks - Multiple consecutive blank lines
+MD012:
+  # Consecutive blank lines
+  maximum: 1
+
+# MD013/line-length - Line length
+MD013:
+  # Number of characters
+  line_length: 80
+  # Number of characters for headings
+  heading_line_length: 80
+  # Number of characters for code blocks
+  code_block_line_length: 80
+  # Include code blocks
+  code_blocks: false
+  # Include tables
+  tables: false
+  # Include headings
+  headings: true
+  # Include headings
+  headers: true
+  # Strict length checking
+  strict: false
+  # Stern length checking
+  stern: false
+
+# MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines
+MD022:
+  # Blank lines above heading
+  lines_above: 1
+  # Blank lines below heading
+  lines_below: 1
+
+# MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content
+MD024:
+  # Only check sibling headings
+  allow_different_nesting: true
+
+# MD025/single-title/single-h1 - Multiple top-level headings in the same document
+MD025:
+  # Heading level
+  level: 1
+  # RegExp for matching title in front matter
+  front_matter_title: "^\\s*title\\s*[:=]"
+
+# MD026/no-trailing-punctuation - Trailing punctuation in heading
+MD026:
+  # Punctuation characters
+  punctuation: ".,;:!。，；：！"
+
+# MD029/ol-prefix - Ordered list item prefix
+MD029:
+  # List style
+  style: "one_or_ordered"
+
+# MD030/list-marker-space - Spaces after list markers
+MD030:
+  # Spaces for single-line unordered list items
+  ul_single: 1
+  # Spaces for single-line ordered list items
+  ol_single: 1
+  # Spaces for multi-line unordered list items
+  ul_multi: 1
+  # Spaces for multi-line ordered list items
+  ol_multi: 1
+
+# MD033/no-inline-html - Inline HTML
+MD033:
+  # Allowed elements
+  allowed_elements: []
+
+# MD035/hr-style - Horizontal rule style
+MD035:
+  # Horizontal rule style
+  style: "---"
+
+# MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading
+MD036:
+  # Punctuation characters
+  punctuation: ".,;:!?。，；：！？"
+
+# MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading
+MD041:
+  # Heading level
+  level: 1
+  # RegExp for matching title in front matter
+  front_matter_title: "^\\s*title\\s*[:=]"
+
+# MD044/proper-names - Proper names should have the correct capitalization
+MD044:
+  # List of proper names
+  names:
+  - network-tools
+  # Include code blocks
+  code_blocks: false
+
+# MD046/code-block-style - Code block style
+MD046:
+  # Block style
+  style: "fenced"
+
+# MD048/code-fence-style - Code fence style
+MD048:
+  # Code fence syle
+  style: "backtick"

Dockerfile

@@ -0,0 +1,20 @@
+FROM docker.io/library/alpine:3.12
+
+ARG NODEJS_VERSION=12.22.6-r0
+ARG MARKDOWNLINT_VERSION
+
+RUN set -ex && \
+    apk add --no-cache nodejs=${NODEJS_VERSION} nodejs-npm=${NODEJS_VERSION}
+
+RUN echo ${MARKDOWNLINT_VERSION}
+
+RUN if [ ! -z "${MARKDOWNLINT_VERSION}" ]; then set -ex; npm install -g markdownlint-cli@${MARKDOWNLINT_VERSION}; fi
+RUN if [ -z "${MARKDOWNLINT_VERSION}" ]; then set -ex; npm install -g markdownlint-cli; fi
+
+RUN set -ex && \
+    npm cache clean --force && \
+    apk del nodejs-npm
+
+WORKDIR /work
+ENTRYPOINT ["/usr/bin/markdownlint"]
+CMD ["."]

LICENSE

@@ -0,0 +1,13 @@
+Copyright 2020 Markus Pesch
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

Makefile

@@ -0,0 +1,53 @@
+# MARKDOWNLINT_VERSION
+# Only required to install a specifiy version
+MARKDOWNLINT_VERSION?=
+
+
+# CONTAINER_RUNTIME
+# The CONTAINER_RUNTIME variable will be used to specified the path to a
+# container runtime. This is needed to start and run a container image.
+CONTAINER_RUNTIME?=$(shell which docker)
+
+# MARKDOWNLINT_IMAGE_REGISTRY_NAME
+# Defines the name of the new container to be built using several variables.
+MARKDOWNLINT_IMAGE_REGISTRY_NAME:=docker.io
+MARKDOWNLINT_IMAGE_REGISTRY_USER:=volkerraschek
+
+MARKDOWNLINT_IMAGE_NAMESPACE?=${MARKDOWNLINT_IMAGE_REGISTRY_USER}
+MARKDOWNLINT_IMAGE_NAME:=markdownlint
+MARKDOWNLINT_IMAGE_VERSION?=latest
+MARKDOWNLINT_IMAGE_FULLY_QUALIFIED=${MARKDOWNLINT_IMAGE_REGISTRY_NAME}/${MARKDOWNLINT_IMAGE_NAMESPACE}/${MARKDOWNLINT_IMAGE_NAME}:${MARKDOWNLINT_IMAGE_VERSION}
+MARKDOWNLINT_IMAGE_UNQUALIFIED=${MARKDOWNLINT_IMAGE_NAMESPACE}/${MARKDOWNLINT_IMAGE_NAME}:${MARKDOWNLINT_IMAGE_VERSION}
+
+# BUILD CONTAINER IMAGE
+# ==============================================================================
+PHONY:=container-image/build
+container-image/build:
+	${CONTAINER_RUNTIME} build \
+		--build-arg MARKDOWNLINT_VERSION=${MARKDOWNLINT_VERSION} \
+		--file Dockerfile \
+		--no-cache \
+		--pull \
+		--tag ${MARKDOWNLINT_IMAGE_FULLY_QUALIFIED} \
+		--tag ${MARKDOWNLINT_IMAGE_UNQUALIFIED} \
+		.
+
+# DELETE CONTAINER IMAGE
+# ==============================================================================
+PHONY:=container-image/delete
+container-image/delete:
+	- ${CONTAINER_RUNTIME} image rm ${MARKDOWNLINT_IMAGE_FULLY_QUALIFIED} ${MARKDOWNLINT_IMAGE_UNQUALIFIED}
+	- ${CONTAINER_RUNTIME} image rm ${BASE_IMAGE_FULL}
+
+# PUSH CONTAINER IMAGE
+# ==============================================================================
+PHONY+=container-image/push
+container-image/push:
+	echo ${MARKDOWNLINT_IMAGE_REGISTRY_PASSWORD} | ${CONTAINER_RUNTIME} login ${MARKDOWNLINT_IMAGE_REGISTRY_NAME} --username ${MARKDOWNLINT_IMAGE_REGISTRY_USER} --password-stdin
+	${CONTAINER_RUNTIME} push ${MARKDOWNLINT_IMAGE_FULLY_QUALIFIED}
+
+# PHONY
+# ==============================================================================
+# Declare the contents of the PHONY variable as phony.  We keep that information
+# in a variable so we can use it in if_changed.
+.PHONY: ${PHONY}

manifest.tmpl

@@ -0,0 +1,20 @@
+image: volkerraschek/markdownlint:{{#if build.tag}}{{trimPrefix "v" build.tag}}{{else}}latest{{/if}}
+{{#if build.tags}}
+tags:
+{{#each build.tags}}
+  - {{this}}
+{{/each}}
+  - "latest"
+{{/if}}
+manifests:
+  -
+    image: volkerraschek/markdownlint:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{else}}latest{{/if}}-amd64
+    platform:
+      architecture: amd64
+      os: linux
+  -
+    image: volkerraschek/markdownlint:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{else}}latest{{/if}}-armv7
+    platform:
+      architecture: arm
+      os: linux
+      variant: v7