From da82c0f30a5f68d6e20557b8251d247c8d7fad16 Mon Sep 17 00:00:00 2001 From: Stephan Schnabel Date: Sat, 14 Jun 2025 13:50:00 +0200 Subject: [PATCH] Initial draft of plugin. --- .github/README.md | 13 ++ .github/workflows/build.yaml | 15 ++ .github/workflows/lint.yaml | 35 +++++ .justfile | 26 ++++ .markdownlint.yaml | 9 ++ .woodpecker/build.yaml | 57 +++++++ .woodpecker/dockerhub.yaml | 17 +++ .woodpecker/lint.yaml | 31 ++++ .woodpecker/test.yaml | 34 +++++ .yamllint.yaml | 19 +++ Dockerfile | 59 +++++++ Dockerfile.dockerignore | 3 + LICENSE | 288 +++++++++++++++++++++++++++++++++++ README.md | 73 +++++++++ entrypoint.sh | 43 ++++++ renovate.json | 33 ++++ 16 files changed, 755 insertions(+) create mode 100644 .github/README.md create mode 100644 .github/workflows/build.yaml create mode 100644 .github/workflows/lint.yaml create mode 100644 .justfile create mode 100644 .markdownlint.yaml create mode 100644 .woodpecker/build.yaml create mode 100644 .woodpecker/dockerhub.yaml create mode 100644 .woodpecker/lint.yaml create mode 100644 .woodpecker/test.yaml create mode 100644 .yamllint.yaml create mode 100644 Dockerfile create mode 100644 Dockerfile.dockerignore create mode 100644 LICENSE create mode 100644 README.md create mode 100755 entrypoint.sh create mode 100644 renovate.json diff --git a/.github/README.md b/.github/README.md new file mode 100644 index 0000000..10735e3 --- /dev/null +++ b/.github/README.md @@ -0,0 +1,13 @@ +# Markdownlint WoodpeckerCI Plugin + +[![pulls](https://img.shields.io/docker/pulls/kokuwaio/markdownlint)](https://hub.docker.com/r/kokuwaio/markdownlint) +[![size](https://img.shields.io/docker/image-size/kokuwaio/markdownlint)](https://hub.docker.com/r/kokuwaio/markdownlint) +[![dockerfile](https://img.shields.io/badge/source-Dockerfile%20-blue)](https://git.kokuwa.io/woodpecker/markdownlint/src/branch/main/Dockerfile) +[![license](https://img.shields.io/badge/License-EUPL%201.2-blue)](https://git.kokuwa.io/woodpecker/markdownlint/src/branch/main/LICENSE) +[![prs](https://img.shields.io/gitea/pull-requests/open/woodpecker/markdownlint?gitea_url=https%3A%2F%2Fgit.kokuwa.io)](https://git.kokuwa.io/woodpecker/markdownlint/pulls) +[![issues](https://img.shields.io/gitea/issues/open/woodpecker/markdownlint?gitea_url=https%3A%2F%2Fgit.kokuwa.io)](https://git.kokuwa.io/woodpecker/markdownlint/issues) + +A [Woodpecker CI](https://woodpecker-ci.org) plugin for [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) to lint markdown files. +Also usable with Gitlab, Github or locally, see examples for usage. + +For more documention see: [git.kokuwa.io/woodpecker/markdownlint](https://git.kokuwa.io/woodpecker/markdownlint) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml new file mode 100644 index 0000000..3ac105f --- /dev/null +++ b/.github/workflows/build.yaml @@ -0,0 +1,15 @@ +name: Build + +on: push + +jobs: + + buildx: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@main + - uses: docker/setup-qemu-action@master + - uses: docker/setup-buildx-action@master + - uses: docker/build-push-action@master + with: + platforms: linux/amd64,linux/arm64 diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml new file mode 100644 index 0000000..1af5647 --- /dev/null +++ b/.github/workflows/lint.yaml @@ -0,0 +1,35 @@ +name: Lint + +on: push + +jobs: + + renovate: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@main + - uses: docker://kokuwaio/renovate-config-validator + + markdownlint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@main + - uses: docker://kokuwaio/markdownlint + + yamllint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@main + - uses: docker://kokuwaio/yamllint + + hadolint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@main + - uses: docker://kokuwaio/hadolint + + shellcheck: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@main + - uses: docker://kokuwaio/shellcheck diff --git a/.justfile b/.justfile new file mode 100644 index 0000000..dbb1a6e --- /dev/null +++ b/.justfile @@ -0,0 +1,26 @@ +# https://just.systems/man/en/ + +[private] +@default: + just --list --unsorted + +# Run linter. +@lint: + docker run --rm --read-only --volume=$(pwd):$(pwd):ro --workdir=$(pwd) kokuwaio/shellcheck + docker run --rm --read-only --volume=$(pwd):$(pwd):ro --workdir=$(pwd) kokuwaio/hadolint + docker run --rm --read-only --volume=$(pwd):$(pwd):ro --workdir=$(pwd) kokuwaio/yamllint + docker run --rm --read-only --volume=$(pwd):$(pwd):rw --workdir=$(pwd) kokuwaio/markdownlint --fix + docker run --rm --read-only --volume=$(pwd):$(pwd):ro --workdir=$(pwd) kokuwaio/renovate + docker run --rm --read-only --volume=$(pwd):$(pwd):ro --workdir=$(pwd) woodpeckerci/woodpecker-cli lint + +# Build image with local docker daemon. +@build: + docker build . --tag=kokuwaio/markdownlint:dev --build-arg=NPM_CONFIG_REGISTRY --load + +# Inspect image with docker. +@inspect: build + docker image inspect kokuwaio/markdownlint:dev + +# Inspect image layers with `dive`. +@dive: build + docker run --rm -it --volume=/var/run/docker.sock:/var/run/docker.sock:ro wagoodman/dive:latest kokuwaio/markdownlint:dev diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 0000000..5f08047 --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,9 @@ +# Default state for all rules +default: true + +# MD009 - Trailing spaces +MD009: + strict: true + +# MD013 - Line length +MD013: false diff --git a/.woodpecker/build.yaml b/.woodpecker/build.yaml new file mode 100644 index 0000000..454e656 --- /dev/null +++ b/.woodpecker/build.yaml @@ -0,0 +1,57 @@ +when: + instance: ci.kokuwa.io + repo: woodpecker/markdownlint + event: [manual, push, pull_request] + branch: main + path: [.woodpecker/build.yaml, Dockerfile, Dockerfile.dockerignore, entrypoint.sh] + +steps: + + build: + image: kokuwaio/buildctl + settings: &settings + name: registry.kokuwa.io/kokuwaio/markdownlint:ci-${CI_PIPELINE_NUMBER} + auth: + registry.kokuwa.io: + username: {from_secret: kokuwa_io_username} + password: {from_secret: kokuwa_io_password} + build-args: {NPM_CONFIG_REGISTRY: "${NPM_CONFIG_REGISTRY}"} + platform: [linux/amd64, linux/arm64] + annotation: + org.opencontainers.image.title: Markdownlint WoodpeckerCI Plugin + org.opencontainers.image.description: A WoodpeckerCI plugin for markdownlint-cli to lint markdown files. + org.opencontainers.image.url: $CI_REPO_URL + org.opencontainers.image.documentation: $CI_REPO_URL/README.md + org.opencontainers.image.source: $CI_REPO_CLONE_URL + org.opencontainers.image.revision: $CI_COMMIT_SHA + org.opencontainers.image.vendor: kokuwa.io + org.opencontainers.image.licenses: EUPL-1.2 + org.opencontainers.image.ref.name: kokuwaio/markdownlint + org.opencontainers.image.version: 0.45.0 + when: + event: pull_request + + push: + image: kokuwaio/buildctl + settings: + <<: *settings + name: + - registry.kokuwa.io/kokuwaio/markdownlint:latest + - registry.kokuwa.io/kokuwaio/markdownlint:0.45.0 + - docker.io/kokuwaio/markdownlint:latest + - docker.io/kokuwaio/markdownlint:0.45.0 + - ghcr.io/kokuwaio/markdownlint:latest + - ghcr.io/kokuwaio/markdownlint:0.45.0 + auth: + "https://index.docker.io/v1/": + username: {from_secret: docker_io_username} + password: {from_secret: docker_io_password} + ghcr.io: + username: {from_secret: ghcr_io_username} + password: {from_secret: ghcr_io_password} + registry.kokuwa.io: + username: {from_secret: kokuwa_io_username} + password: {from_secret: kokuwa_io_password} + when: + event: [manual, push] + branch: main diff --git a/.woodpecker/dockerhub.yaml b/.woodpecker/dockerhub.yaml new file mode 100644 index 0000000..e5caf87 --- /dev/null +++ b/.woodpecker/dockerhub.yaml @@ -0,0 +1,17 @@ +when: + instance: ci.kokuwa.io + repo: woodpecker/markdownlint + event: [manual, push] + branch: main + path: [.woodpecker/dockerhub.yaml, README.md] + +steps: + + metadata: + image: kokuwaio/dockerhub-metadata + settings: + repository: kokuwaio/markdownlint + description-short: A WoodpeckerCI plugin for markdownlint-cli to lint markdown files. + categories: [developer-tools, integration-and-delivery] + username: {from_secret: dockerhub_username} + password: {from_secret: dockerhub_password} diff --git a/.woodpecker/lint.yaml b/.woodpecker/lint.yaml new file mode 100644 index 0000000..59a1252 --- /dev/null +++ b/.woodpecker/lint.yaml @@ -0,0 +1,31 @@ +when: + event: [manual, push, pull_request] + branch: main + path: [.woodpecker/lint.yaml, renovate.json, "**/*.yaml", "**/*.md", "**/*.sh", "**/Dockerfile"] + +steps: + + renovate: + image: kokuwaio/renovate-config-validator + depends_on: [] + when: [path: [.woodpecker/lint.yaml, renovate.json]] + + yaml: + image: kokuwaio/yamllint + depends_on: [] + when: [path: [.woodpecker/lint.yaml, .yamllint.yaml, "**/*.yaml"]] + + markdown: + image: kokuwaio/markdownlint + depends_on: [] + when: [path: [.woodpecker/lint.yaml, .markdownlint.yaml, "**/*.md"]] + + dockerfile: + image: kokuwaio/hadolint + depends_on: [] + when: [path: [.woodpecker/lint.yaml, "**/Dockerfile"]] + + shellcheck: + image: kokuwaio/shellcheck + depends_on: [] + when: [path: [.woodpecker/lint.yaml, "**/*.sh"]] diff --git a/.woodpecker/test.yaml b/.woodpecker/test.yaml new file mode 100644 index 0000000..7989d9b --- /dev/null +++ b/.woodpecker/test.yaml @@ -0,0 +1,34 @@ +when: + instance: ci.kokuwa.io + repo: woodpecker/markdownlint + event: [manual, push, pull_request] + branch: main + path: [.woodpecker/build.yaml, Dockerfile, Dockerfile.dockerignore, entrypoint.sh] + +depends_on: [build] +matrix: + PLATFORM: [amd64, arm64] +labels: + platform: linux/${PLATFORM} + +steps: + + pr: + image: registry.kokuwa.io/kokuwaio/markdownlint:ci-${CI_PIPELINE_NUMBER} + when: + event: pull_request + + kokuwa.io: &version + image: registry.kokuwa.io/kokuwaio/markdownlint + pull: true + when: + event: [manual, push] + branch: main + + docker.io: + image: docker.io/kokuwaio/markdownlint + <<: *version + + ghcr.io: + image: ghcr.io/kokuwaio/markdownlint + <<: *version diff --git a/.yamllint.yaml b/.yamllint.yaml new file mode 100644 index 0000000..8011808 --- /dev/null +++ b/.yamllint.yaml @@ -0,0 +1,19 @@ +extends: default + +## see https://yamllint.readthedocs.io/en/stable/rules.html +rules: + + # no need for document start + document-start: disable + + # line length is not important + line-length: disable + + # force double quotes everywhere + quoted-strings: + quote-type: double + required: only-when-needed + + # allow everything on keys + truthy: + check-keys: false diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..f4ab3c2 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,59 @@ +## +## Download node and markdownlint +## + +FROM docker.io/library/debian:12.11-slim@sha256:e5865e6858dacc255bead044a7f2d0ad8c362433cfaa5acefb670c1edf54dfef AS build +SHELL ["/bin/bash", "-u", "-e", "-o", "pipefail", "-c"] +WORKDIR /build +# hadolint ignore=DL3008 +RUN --mount=type=cache,target=/var/lib/apt/lists,sharing=locked \ + apt-get -qq update && \ + apt-get -qq install --yes --no-install-recommends ca-certificates wget gpg gpg-agent dirmngr xz-utils && \ + rm -rf /etc/*- /var/lib/dpkg/*-old /var/lib/dpkg/status /var/cache/* /var/log/* + +# fetch gpg keys for verification +# https://github.com/nodejs/node?tab=readme-ov-file#release-keys +RUN gpg --keyserver=hkps://keys.openpgp.org --recv-keys \ + C0D6248439F1D5604AAFFB4021D900FFDB233756 \ + DD792F5973C6DE52C432CBDAC77ABFA00DDBF2B7 \ + CC68F5A3106FF448322E48ED27F5E38D5B0A215F \ + 8FCCA13FEF1D0C2E91008E09770F7A9A5AE15600 \ + 890C08DB8579162FEE0DF9DB8BEAB4DFCF555EF4 \ + C82FA3AE1CBEDC6BE46B9360C43CEC45C17AB93C \ + 108F52B48DB57BB0CC439B2997B01419BD92F80A \ + A363A499291CBBC940DD62E41F10027AF002F8B0 + +# https://github.com/nodejs/node/tags +# https://github.com/nodejs/node#verifying-binaries +# https://nodejs.org/en/download/releases/ +# https://endoflife.date/nodejs + +RUN --mount=type=cache,target=/build \ + ARCH=$(dpkg --print-architecture); \ + [[ $ARCH == amd64 ]] && export SUFFIX=x64; \ + [[ $ARCH == arm64 ]] && export SUFFIX=arm64; \ + [[ -z ${SUFFIX:-} ]] && echo "Unknown arch: $ARCH" && exit 1; \ + wget --no-hsts --quiet \ + "https://nodejs.org/download/release/v22.16.0/node-v22.16.0-linux-$SUFFIX.tar.xz" \ + "https://nodejs.org/download/release/v22.16.0/SHASUMS256.txt" \ + "https://nodejs.org/download/release/v22.16.0/SHASUMS256.txt.sig" && \ + sha256sum --quiet --check --strict --ignore-missing SHASUMS256.txt && \ + gpg --verify SHASUMS256.txt.sig SHASUMS256.txt 2>/dev/null && \ + tar --xz --extract --file="node-v22.16.0-linux-$SUFFIX.tar.xz" --exclude=bin/npx --exclude=bin/corepack --exclude=lib/node_modules/corepack --exclude=include --exclude=share --no-same-owner && \ + mv "node-v22.16.0-linux-$SUFFIX" /opt/node + +ARG NPM_CONFIG_REGISTRY +RUN --mount=type=tmpfs,target=/tmp PATH="$PATH:/opt/node/bin" npm install "markdownlint-cli@0.45.0" --global --no-fund --cache=/tmp + +## +## Final stage +## + +FROM docker.io/library/debian:12.11-slim@sha256:e5865e6858dacc255bead044a7f2d0ad8c362433cfaa5acefb670c1edf54dfef +COPY --chmod=555 --from=build /opt/node/bin/node /opt/node/bin/ +COPY --from=build /opt/node/lib/node_modules/markdownlint-cli /opt/node/lib/node_modules/markdownlint-cli +COPY --chmod=555 entrypoint.sh /usr/local/bin/entrypoint.sh +ENV PATH="$PATH:/opt/node/bin" +RUN ln -s /opt/node/lib/node_modules/markdownlint-cli/markdownlint.js /opt/node/bin/markdownlint && markdownlint --version +ENTRYPOINT ["/usr/local/bin/entrypoint.sh"] +USER 1000:1000 diff --git a/Dockerfile.dockerignore b/Dockerfile.dockerignore new file mode 100644 index 0000000..51187c3 --- /dev/null +++ b/Dockerfile.dockerignore @@ -0,0 +1,3 @@ +.* + +!entrypoint.sh diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ebcf5a5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,288 @@ + + EUROPEAN UNION PUBLIC LICENCE v. 1.2 + EUPL © the European Union 2007, 2016 + +This European Union Public Licence (the 'EUPL') applies to the Work (as defined +below) which is provided under the terms of this Licence. Any use of the Work, +other than as authorised under this Licence is prohibited (to the extent such +use is covered by a right of the copyright holder of the Work). + +The Work is provided under the terms of this Licence when the Licensor (as +defined below) has placed the following notice immediately following the +copyright notice for the Work: + + Licensed under the EUPL + +or has expressed by any other means his willingness to license under the EUPL. + +1. Definitions + +In this Licence, the following terms have the following meaning: + +- 'The Licence': this Licence. + +- 'The Original Work': the work or software distributed or communicated by the + Licensor under this Licence, available as Source Code and also as Executable + Code as the case may be. + +- 'Derivative Works': the works or software that could be created by the + Licensee, based upon the Original Work or modifications thereof. This Licence + does not define the extent of modification or dependence on the Original Work + required in order to classify a work as a Derivative Work; this extent is + determined by copyright law applicable in the country mentioned in Article 15. + +- 'The Work': the Original Work or its Derivative Works. + +- 'The Source Code': the human-readable form of the Work which is the most + convenient for people to study and modify. + +- 'The Executable Code': any code which has generally been compiled and which is + meant to be interpreted by a computer as a program. + +- 'The Licensor': the natural or legal person that distributes or communicates + the Work under the Licence. + +- 'Contributor(s)': any natural or legal person who modifies the Work under the + Licence, or otherwise contributes to the creation of a Derivative Work. + +- 'The Licensee' or 'You': any natural or legal person who makes any usage of + the Work under the terms of the Licence. + +- 'Distribution' or 'Communication': any act of selling, giving, lending, + renting, distributing, communicating, transmitting, or otherwise making + available, online or offline, copies of the Work or providing access to its + essential functionalities at the disposal of any other natural or legal + person. + +2. Scope of the rights granted by the Licence + +The Licensor hereby grants You a worldwide, royalty-free, non-exclusive, +sublicensable licence to do the following, for the duration of copyright vested +in the Original Work: + +- use the Work in any circumstance and for all usage, +- reproduce the Work, +- modify the Work, and make Derivative Works based upon the Work, +- communicate to the public, including the right to make available or display + the Work or copies thereof to the public and perform publicly, as the case may + be, the Work, +- distribute the Work or copies thereof, +- lend and rent the Work or copies thereof, +- sublicense rights in the Work or copies thereof. + +Those rights can be exercised on any media, supports and formats, whether now +known or later invented, as far as the applicable law permits so. + +In the countries where moral rights apply, the Licensor waives his right to +exercise his moral right to the extent allowed by law in order to make effective +the licence of the economic rights here above listed. + +The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to +any patents held by the Licensor, to the extent necessary to make use of the +rights granted on the Work under this Licence. + +3. Communication of the Source Code + +The Licensor may provide the Work either in its Source Code form, or as +Executable Code. If the Work is provided as Executable Code, the Licensor +provides in addition a machine-readable copy of the Source Code of the Work +along with each copy of the Work that the Licensor distributes or indicates, in +a notice following the copyright notice attached to the Work, a repository where +the Source Code is easily and freely accessible for as long as the Licensor +continues to distribute or communicate the Work. + +4. Limitations on copyright + +Nothing in this Licence is intended to deprive the Licensee of the benefits from +any exception or limitation to the exclusive rights of the rights owners in the +Work, of the exhaustion of those rights or of other applicable limitations +thereto. + +5. Obligations of the Licensee + +The grant of the rights mentioned above is subject to some restrictions and +obligations imposed on the Licensee. Those obligations are the following: + +Attribution right: The Licensee shall keep intact all copyright, patent or +trademarks notices and all notices that refer to the Licence and to the +disclaimer of warranties. The Licensee must include a copy of such notices and a +copy of the Licence with every copy of the Work he/she distributes or +communicates. The Licensee must cause any Derivative Work to carry prominent +notices stating that the Work has been modified and the date of modification. + +Copyleft clause: If the Licensee distributes or communicates copies of the +Original Works or Derivative Works, this Distribution or Communication will be +done under the terms of this Licence or of a later version of this Licence +unless the Original Work is expressly distributed only under this version of the +Licence — for example by communicating 'EUPL v. 1.2 only'. The Licensee +(becoming Licensor) cannot offer or impose any additional terms or conditions on +the Work or Derivative Work that alter or restrict the terms of the Licence. + +Compatibility clause: If the Licensee Distributes or Communicates Derivative +Works or copies thereof based upon both the Work and another work licensed under +a Compatible Licence, this Distribution or Communication can be done under the +terms of this Compatible Licence. For the sake of this clause, 'Compatible +Licence' refers to the licences listed in the appendix attached to this Licence. +Should the Licensee's obligations under the Compatible Licence conflict with +his/her obligations under this Licence, the obligations of the Compatible +Licence shall prevail. + +Provision of Source Code: When distributing or communicating copies of the Work, +the Licensee will provide a machine-readable copy of the Source Code or indicate +a repository where this Source will be easily and freely available for as long +as the Licensee continues to distribute or communicate the Work. + +Legal Protection: This Licence does not grant permission to use the trade names, +trademarks, service marks, or names of the Licensor, except as required for +reasonable and customary use in describing the origin of the Work and +reproducing the content of the copyright notice. + +6. Chain of Authorship + +The original Licensor warrants that the copyright in the Original Work granted +hereunder is owned by him/her or licensed to him/her and that he/she has the +power and authority to grant the Licence. + +Each Contributor warrants that the copyright in the modifications he/she brings +to the Work are owned by him/her or licensed to him/her and that he/she has the +power and authority to grant the Licence. + +Each time You accept the Licence, the original Licensor and subsequent +Contributors grant You a licence to their contributions to the Work, under the +terms of this Licence. + +7. Disclaimer of Warranty + +The Work is a work in progress, which is continuously improved by numerous +Contributors. It is not a finished work and may therefore contain defects or +'bugs' inherent to this type of development. + +For the above reason, the Work is provided under the Licence on an 'as is' basis +and without warranties of any kind concerning the Work, including without +limitation merchantability, fitness for a particular purpose, absence of defects +or errors, accuracy, non-infringement of intellectual property rights other than +copyright as stated in Article 6 of this Licence. + +This disclaimer of warranty is an essential part of the Licence and a condition +for the grant of any rights to the Work. + +8. Disclaimer of Liability + +Except in the cases of wilful misconduct or damages directly caused to natural +persons, the Licensor will in no event be liable for any direct or indirect, +material or moral, damages of any kind, arising out of the Licence or of the use +of the Work, including without limitation, damages for loss of goodwill, work +stoppage, computer failure or malfunction, loss of data or any commercial +damage, even if the Licensor has been advised of the possibility of such damage. +However, the Licensor will be liable under statutory product liability laws as +far such laws apply to the Work. + +9. Additional agreements + +While distributing the Work, You may choose to conclude an additional agreement, +defining obligations or services consistent with this Licence. However, if +accepting obligations, You may act only on your own behalf and on your sole +responsibility, not on behalf of the original Licensor or any other Contributor, +and only if You agree to indemnify, defend, and hold each Contributor harmless +for any liability incurred by, or claims asserted against such Contributor by +the fact You have accepted any warranty or additional liability. + +10. Acceptance of the Licence + +The provisions of this Licence can be accepted by clicking on an icon 'I agree' +placed under the bottom of a window displaying the text of this Licence or by +affirming consent in any other similar way, in accordance with the rules of +applicable law. Clicking on that icon indicates your clear and irrevocable +acceptance of this Licence and all of its terms and conditions. + +Similarly, you irrevocably accept this Licence and all of its terms and +conditions by exercising any rights granted to You by Article 2 of this Licence, +such as the use of the Work, the creation by You of a Derivative Work or the +Distribution or Communication by You of the Work or copies thereof. + +11. Information to the public + +In case of any Distribution or Communication of the Work by means of electronic +communication by You (for example, by offering to download the Work from a +remote location) the distribution channel or media (for example, a website) must +at least provide to the public the information requested by the applicable law +regarding the Licensor, the Licence and the way it may be accessible, concluded, +stored and reproduced by the Licensee. + +12. Termination of the Licence + +The Licence and the rights granted hereunder will terminate automatically upon +any breach by the Licensee of the terms of the Licence. + +Such a termination will not terminate the licences of any person who has +received the Work from the Licensee under the Licence, provided such persons +remain in full compliance with the Licence. + +13. Miscellaneous + +Without prejudice of Article 9 above, the Licence represents the complete +agreement between the Parties as to the Work. + +If any provision of the Licence is invalid or unenforceable under applicable +law, this will not affect the validity or enforceability of the Licence as a +whole. Such provision will be construed or reformed so as necessary to make it +valid and enforceable. + +The European Commission may publish other linguistic versions or new versions of +this Licence or updated versions of the Appendix, so far this is required and +reasonable, without reducing the scope of the rights granted by the Licence. New +versions of the Licence will be published with a unique version number. + +All linguistic versions of this Licence, approved by the European Commission, +have identical value. Parties can take advantage of the linguistic version of +their choice. + +14. Jurisdiction + +Without prejudice to specific agreement between parties, + +- any litigation resulting from the interpretation of this License, arising + between the European Union institutions, bodies, offices or agencies, as a + Licensor, and any Licensee, will be subject to the jurisdiction of the Court + of Justice of the European Union, as laid down in article 272 of the Treaty on + the Functioning of the European Union, + +- any litigation arising between other parties and resulting from the + interpretation of this License, will be subject to the exclusive jurisdiction + of the competent court where the Licensor resides or conducts its primary + business. + +15. Applicable Law + +Without prejudice to specific agreement between parties, + +- this Licence shall be governed by the law of the European Union Member State + where the Licensor has his seat, resides or has his registered office, + +- this licence shall be governed by Belgian law if the Licensor has no seat, + residence or registered office inside a European Union Member State. + +Appendix + +'Compatible Licences' according to Article 5 EUPL are: + +- GNU General Public License (GPL) v. 2, v. 3 +- GNU Affero General Public License (AGPL) v. 3 +- Open Software License (OSL) v. 2.1, v. 3.0 +- Eclipse Public License (EPL) v. 1.0 +- CeCILL v. 2.0, v. 2.1 +- Mozilla Public Licence (MPL) v. 2 +- GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3 +- Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for + works other than software +- European Union Public Licence (EUPL) v. 1.1, v. 1.2 +- Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong + Reciprocity (LiLiQ-R+). + +The European Commission may update this Appendix to later versions of the above +licences without producing a new version of the EUPL, as long as they provide +the rights granted in Article 2 of this Licence and protect the covered Source +Code from exclusive appropriation. + +All other changes or additions to this Appendix require the production of a new +EUPL version. diff --git a/README.md b/README.md new file mode 100644 index 0000000..a8e9e4f --- /dev/null +++ b/README.md @@ -0,0 +1,73 @@ +# Markdownlint WoodpeckerCI Plugin + +[![pulls](https://img.shields.io/docker/pulls/kokuwaio/markdownlint)](https://hub.docker.com/r/kokuwaio/dockerhub-metadata) +[![size](https://img.shields.io/docker/image-size/kokuwaio/markdownlint)](https://hub.docker.com/r/kokuwaio/markdownlint) +[![dockerfile](https://img.shields.io/badge/source-Dockerfile%20-blue)](https://git.kokuwa.io/woodpecker/markdownlint/src/branch/main/Dockerfile) +[![license](https://img.shields.io/badge/License-EUPL%201.2-blue)](https://git.kokuwa.io/woodpecker/markdownlint/src/branch/main/LICENSE) +[![prs](https://img.shields.io/gitea/pull-requests/open/woodpecker/markdownlint?gitea_url=https%3A%2F%2Fgit.kokuwa.io)](https://git.kokuwa.io/woodpecker/markdownlint/pulls) +[![issues](https://img.shields.io/gitea/issues/open/woodpecker/markdownlint?gitea_url=https%3A%2F%2Fgit.kokuwa.io)](https://git.kokuwa.io/woodpecker/markdownlint/issues) + +A [Woodpecker CI](https://woodpecker-ci.org) plugin for [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) to lint markdown files. +Also usable with Gitlab, Github or locally, see examples for usage. + +## Features + +- preconfigure markdownlint-cli parameters +- searches for markdown files recursive +- runnable with local docker daemon + +## Example + +Woodpecker: + +```yaml +steps: + markdownlint: + image: kokuwaio/markdownlint + settings: + dot: true + enable: [MD013, MD041] + when: + event: pull_request + path: [.markdownlint.yaml, "**/*.md"]] +``` + +Gitlab: + +```yaml +markdownlint: + stage: lint + image: kokuwaio/markdownlint + variables: + PLUGIN_DOT: true + PLUGIN_ENABLE: MD013,MD041 + rules: + - if: $CI_PIPELINE_SOURCE == "merge_request_event" + changes: [.markdownlint.yaml, "**/*.md"] +``` + +CLI: + +```bash +docker run --rm --volume=$(pwd):$(pwd):rw --workdir=$(pwd) kokuwaio/markdownlint --fix +``` + +## Settings + +| Settings Name | Environment | Default | Description | +| --------------| ------------------ | ------- | -------------------------------------------------------- | +| `config-file` | PLUGIN_CONFIG_FILE | `none` | Configuration file (JSON, JSONC, JS, YAML, or TOML) | +| `dot` | PLUGIN_DOT | `true` | Include files/folders with a dot (for example `.github`) | +| `enable` | PLUGIN_ENABLE | `none` | Enable certain rules, e.g. --enable=MD013,MD041 | +| `disable` | PLUGIN_DISABLE | `none` | Disable certain rules, e.g. --disable=MD013,MD041 | + +## Alternatives + +| Image | Comment | amd64 | arm64 | +| ---------------------------------------------------------------------------------------- | --------------------------------- |:-----:|:-----:| +| [kokuwaio/markdownlint](https://hub.docker.com/r/kokuwaio/markdownlint) | Woodpecker plugin | [![size](https://img.shields.io/docker/image-size/kokuwaio/markdownlint?arch=amd64&label=)](https://hub.docker.com/r/kokuwaio/markdownlint) | [![size](https://img.shields.io/docker/image-size/kokuwaio/markdownlint?arch=arm64&label=)](https://hub.docker.com/r/kokuwaio/markdownlint) | +| [ghcr.io/igorshubovych/markdownlint-cli](https://ghcr.io/igorshubovych/markdownlint-cli) | not a Woodpecker plugin, official | [![size](https://img.shields.io/docker/image-size/kokuwaio/markdownlint?arch=amd64&label=)](https://hub.docker.com/r/ghcr.io/igorshubovych/markdownlint-cli) | [![size](https://img.shields.io/docker/image-size/ghcr.io/igorshubovych/markdownlint-cli?arch=arm64&label=)](https://hub.docker.com/r/ghcr.io/igorshubovych/markdownlint-cli) | +| [tmknom/markdownlint](https://hub.docker.com/r/tmknom/markdownlint) | not a Woodpecker plugin | [![size](https://img.shields.io/docker/image-size/tmknom/markdownlint?arch=amd64&label=)](https://hub.docker.com/r/tmknom/markdownlint) | [![size](https://img.shields.io/docker/image-size/tmknom/markdownlint?arch=arm64&label=)](https://hub.docker.com/r/tmknom/markdownlint) | +| [thegeeklab/markdownlint-cli](https://hub.docker.com/r/thegeeklab/markdownlint-cli) | not a Woodpecker plugin | [![size](https://img.shields.io/docker/image-size/thegeeklab/markdownlint-cli?arch=amd64&label=)](https://hub.docker.com/r/thegeeklab/markdownlint-cli) | [![size](https://img.shields.io/docker/image-size/thegeeklab/markdownlint-cli?arch=arm64&label=)](https://hub.docker.com/r/thegeeklab/markdownlint-cli) | +| [peterdavehello/markdownlint](https://hub.docker.com/r/peterdavehello/markdownlint) | not a Woodpecker plugin | [![size](https://img.shields.io/docker/image-size/peterdavehello/markdownlint?arch=amd64&label=)](https://hub.docker.com/r/peterdavehello/markdownlint) | [![size](https://img.shields.io/docker/image-size/peterdavehello/markdownlint?arch=arm64&label=)](https://hub.docker.com/r/peterdavehello/markdownlint) | +| [06kellyjac/markdownlint-cli](https://hub.docker.com/r/06kellyjac/markdownlint-cli) | not a Woodpecker plugin, outdated | [![size](https://img.shields.io/docker/image-size/06kellyjac/markdownlint-cli?arch=amd64&label=)](https://hub.docker.com/r/06kellyjac/markdownlint-cli) | [![size](https://img.shields.io/docker/image-size/06kellyjac/markdownlint-cli?arch=arm64&label=)](https://hub.docker.com/r/06kellyjac/markdownlint-cli) | diff --git a/entrypoint.sh b/entrypoint.sh new file mode 100755 index 0000000..3dee544 --- /dev/null +++ b/entrypoint.sh @@ -0,0 +1,43 @@ +#!/bin/bash +set -eu; + +## +## check if any markdown file is present +## + +FILES=$(find "$(pwd)" -type f -name '*.md') +if [[ ! "$FILES" ]]; then + echo "No markdown file found!" + exit 1 +fi + +## +## build command +## + +COMMAND="markdownlint" +if [[ -n "${PLUGIN_CONFIG_FILE:-}" ]]; then + COMMAND+=" --config=$PLUGIN_CONFIG_FILE" +fi +if [[ "${PLUGIN_DOT:-true}" == "true" ]]; then + COMMAND+=" --dot" +fi +if [[ -n "${PLUGIN_ENABLE:-}" ]]; then + COMMAND+=" --enable=$PLUGIN_ENABLE" +fi +if [[ -n "${PLUGIN_DISABLE:-}" ]]; then + COMMAND+=" --disable=$PLUGIN_DISABLE" +fi +COMMAND+=" $(pwd)" + +# custom args, e.g. docker run --rm --volume=$(pwd):$(pwd) --workdir=$(pwd) --env=CI=test kokuwaio/yamllint --format=json +if [[ -n "${1:-}" ]]; then + COMMAND+=" $*" +fi + +## +## build environment +## + +echo "$COMMAND" +eval "$COMMAND" diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000..4162f8e --- /dev/null +++ b/renovate.json @@ -0,0 +1,33 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "extends": ["local>infrastructure/renovate-config", ":reviewer(stephan.schnabel)"], + "packageRules": [ + { + "matchPackageNames": ["nodejs/node"], + "matchUpdateTypes": ["major"], + "enabled": false + } + ], + "customManagers": [ + { + "customType": "regex", + "managerFilePatterns": ["Dockerfile", ".woodpecker/build.yaml"], + "matchStrings": [ + "kokuwaio/markdownlint:(?[0-9]+\\.[0-9]+\\.[0-9]+)", + "markdownlint-cli@(?[0-9]+\\.[0-9]+\\.[0-9]+)", + "version: (?[0-9]+\\.[0-9]+\\.[0-9]+)" + ], + "datasourceTemplate": "npm", + "packageNameTemplate": "markdownlint-cli" + },{ + "customType": "regex", + "managerFilePatterns": ["Dockerfile"], + "matchStrings": [ + "nodejs.org/download/release/(?v[0-9]+\\.[0-9]+\\.[0-9]+)/", + "node-(?v[0-9]+\\.[0-9]+\\.[0-9]+)-linux-\\$SUFFIX" + ], + "datasourceTemplate": "github-releases", + "packageNameTemplate": "nodejs/node" + } + ] +}