From 39983be85502bb247887cf3ba03604766145c052 Mon Sep 17 00:00:00 2001 From: --show-origin Date: Mon, 30 Oct 2023 02:17:49 -0700 Subject: [PATCH] ci: added markdown linting --- .github/workflows/lint-markdown.yaml | 49 ++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 .github/workflows/lint-markdown.yaml diff --git a/.github/workflows/lint-markdown.yaml b/.github/workflows/lint-markdown.yaml new file mode 100644 index 00000000..b2710ee1 --- /dev/null +++ b/.github/workflows/lint-markdown.yaml @@ -0,0 +1,49 @@ +#******************************************************************************** +# Copyright (c) 2022 Mercedes-Benz Tech Innovation GmbH +# Copyright (c) 2022 Contributors to the Eclipse Foundation +# Copyright (c) 2023 Volkswagen AG +# Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. +# (represented by Fraunhofer ISST) +# +# See the NOTICE file(s) distributed with this work for additional +# information regarding copyright ownership. +# +# This program and the accompanying materials are made available under the +# terms of the Apache License, Version 2.0 which is available at +# https://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. +# +# SPDX-License-Identifier: Apache-2.0 +#*******************************************************************************/ + +name: Markdown linting for documentation + +on: + pull_request: + branches: + - main + +# This job will run markdown linting to ensure uniform .md style +jobs: + lint: + if: github.repository_owner == 'eclipse-tractusx' # prevent running on forks + name: Run markdown lint + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - uses: actions/setup-node@v3 + with: + node-version: 16 + cache: npm + + - name: Install dependencies + run: npm ci + + - name: Run markdown lint + run: npm run lint-doc