actionshub/markdownlint

Repository for the markdownlint-mdl-action Github Action

actionshub

A metadata repository to hold issues and thoughts for the org

markdownlint's Issues

v2.1.0 and main breaks build

👻 Brief Description

Build fail

🥞 Action version

actionshub/markdownlint@main and actionshub/[email protected]

🎩 workflow configuration

name: mdl

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main
  schedule:
    - cron: "0 21 * * 6"

jobs:
  mdl:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3
      - name: run mdl
        uses: actionshub/markdownlint@main
        with:
          filesToIgnoreRegex: "vendor/"

Steps To Reproduce

Run build. Example fail: https://github.com/evemonk/evemonk/actions/runs/3706085119/jobs/6280844288

2022-12-15T16:40:39.6021318Z Download action repository 'actions/checkout@v3' (SHA:755da8c3cf115ac066823e79a1e1788f8940201b)
2022-12-15T16:40:39.8961050Z Download action repository 'actionshub/[email protected]' (SHA:25ad93c49091a0e97193d4484c0b7ec752e0d087)
2022-12-15T16:40:40.3285149Z ##[group]Pull down action image 'ghcr.io/actionshub/markdownlint:v2.1.0'
2022-12-15T16:40:40.3359759Z ##[command]/usr/bin/docker pull ghcr.io/actionshub/markdownlint:v2.1.0
2022-12-15T16:40:40.4937706Z Error response from daemon: Head "https://ghcr.io/v2/actionshub/markdownlint/manifests/v2.1.0": denied
2022-12-15T16:40:40.4961961Z ##[warning]Docker pull failed with exit code 1, back off 1.583 seconds before retry.
2022-12-15T16:40:42.0802982Z ##[command]/usr/bin/docker pull ghcr.io/actionshub/markdownlint:v2.1.0
2022-12-15T16:40:42.1761503Z Error response from daemon: Head "https://ghcr.io/v2/actionshub/markdownlint/manifests/v2.1.0": denied
2022-12-15T16:40:42.1780255Z ##[warning]Docker pull failed with exit code 1, back off 3.767 seconds before retry.
2022-12-15T16:40:45.9404463Z ##[command]/usr/bin/docker pull ghcr.io/actionshub/markdownlint:v2.1.0
2022-12-15T16:40:46.0296241Z Error response from daemon: Head "https://ghcr.io/v2/actionshub/markdownlint/manifests/v2.1.0": denied
2022-12-15T16:40:46.0309389Z ##[endgroup]
2022-12-15T16:40:46.0394716Z ##[error]Docker pull failed with exit code 1
2022-12-15T16:40:46.0551735Z Cleaning up orphan processes

Docker image v3.0.0 cannot be pulled

👻 Brief Description

When running the action, its image cannot be pulled.

Pull down action image 'ghcr.io/actionshub/markdownlint:v3.0.0'
  /usr/bin/docker pull ghcr.io/actionshub/markdownlint:v3.0.0

🥞 Action version

latest version

🎩 workflow configuration

"vanilla" setup

      - name: markdownlint-cli
        uses: actionshub/markdownlint@main

Steps To Reproduce

Basically run the action, that's it 😄

🚓 Expected behavior

Image should be pulled

Ignore a folder

We would like to check all files in the repository (.) but then exclude files that are not ours (/vendor).

Currently file exclusions are not supported with path input.

Not possible to open PR

Hi 👋,
I'm not able to create a PR against your Repo, is this beaver desired?

Cheers 🍻
Richard

mdl action finds non-md files

👻 Brief Description

the mdl action seems to (possibly only when filesToIgnoreRegex is set?) find non-Markdown files (specifically, in this case, ruby files) and lint them (which obviously won't work).

🥞 Action version

1.2.2

🎩 workflow configuration

  markdown:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout repository
      uses: actions/checkout@v2
    - name: Lint Markdown
      uses: actionshub/[email protected]
      with:
        filesToIgnoreRegex: '((test|example|bin)/.*|doc/RULES.md)'

Steps To Reproduce

Steps to reproduce the behavior:

1. Use above config
2. have a ruby file
3. see it fail on ruby files

Ex: this test

🚓 Expected behavior

It does not try to lint Ruby files.

➕ Additional context

Add any other context about the problem here. e.g. related issues or existing pull requests.

filesToIgnoreRegex doesn't seem to work

👻 Brief Description

filesToIgnoreRegex doesn't seem to work.

🥞 Action version

1.2.2

🎩 workflow configuration

jobs:
  markdown:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout repository
      uses: actions/checkout@v2
    - name: Lint Markdown
      uses: actionshub/[email protected]
      with:
        filesToIgnoreRegex: '((test|example|bin)/.*|doc/RULES.md)'

The RE does match:

$ echo test/rule_tests/lists_without_blank_lines.md | grep -oE '((test|example|bin)/.*|doc/RULES.md)'
test/rule_tests/lists_without_blank_lines.md

Steps To Reproduce

1. Create file called test/rule_tests/lists_without_blank_lines.md
2. add config like above

You can see this in this test where that file (and many other like it) get matched.

🚓 Expected behavior

It ignores the file.

exec user process caused "no such file or directory" in v1.2.1

🗣️ Foreword

Thank for taking the time to fill this bug report fully. Without it we may not be able to fix the bug, and the issue may be closed without resolution.

👻 Brief Description

The current version 1.2.1 of this action fails with:

Run actionshub/[email protected]
/usr/bin/docker run ....
standard_init_linux.go:211: exec user process caused "no such file or directory"

Seems to be fixed in master with c8fe67f. Can you release a new version?

🥞 Action version

v1.2.1

🎩 workflow configuration

https://github.com/p1nkun1c0rns/deploy-google-cloud-run-action/blob/master/.github/workflows/test.yml

Steps To Reproduce

Steps to reproduce the behavior:

1. Use it 😄

🚓 Expected behavior

Linting and not failing.

➕ Additional context

❤️

Container image tag v3.1.0 missing

🗣️ Foreword

Thank for taking the time to fill this bug report fully. Without it we may not be able to fix the bug, and the issue may be closed without resolution.

👻 Brief Description

The Github action fails with:

Pull down action image 'ghcr.io/actionshub/markdownlint:v3.1.0'
  /usr/bin/docker pull ghcr.io/actionshub/markdownlint:v3.1.0
  Error response from daemon: manifest unknown

See https://github.com/linux-system-roles/network/actions/runs/4160529110/jobs/7197585345

v3.1.0 is not tagged:
https://github.com/actionshub/markdownlint/pkgs/container/markdownlint/versions?filters%5Bversion_type%5D=tagged

🥞 Action version

main

🎩 workflow configuration

https://github.com/linux-system-roles/network/blob/main/.github/workflows/markdownlint.yml

Steps To Reproduce

Create a PR with markdownlint workflow above

🚓 Expected behavior

markdownlint should run

➕ Additional context

#34 bumped the release but it seems it the workflow does not properly tag the container image.

run limited set of rules / exclude rules

😦 Problem Statement

(GitHub doesn't have :person_frowning: as a shortcode for 🙍)

Right now this action runs mdl with all the lint rules active.

I maintain a project that has multilingual README/CONTRIBUTING files that contain right-to-left languages, which require HTML tags along with assembly code examples that conflict with spacing rules. As it stands there is no way to disable these lint rules from being run.

❔ Possible Solution

Matching mdl's behaviour:

• If rules are defined, only those rules are run (e.g mdl --rules MD001 only checks MD001)
• If rules are prefixed with ~, those rules are excluded (mdl --rules ~MD001 checks every rule except MD001)

The following configuration would call mdl --rules ~MD001,~MD002:

jobs:
  delivery:
    runs-on: ubuntu-latest
    steps:
    - name: Check out code
      uses: actions/checkout@master
    - name: Run mdl
      uses: actionshub/markdownlint@master
      with:
        rules: ~MD001,~MD002

➕ Additional context

I currently have a fork with the rules I need disabled hardcoded in the entrypoint.sh at https://github.com/wopian/markdownlint

Current master fails because alpine

Hi!

Since switching to Alpine the master branch no longer works as Alpine misses some libraries causing the script to fail.

I've reverted to 1.2.0 and the action runs as expected.

problem matchers

:person_frowning: Problem Statement

Setup problem matchers for markdownlint to help people fix issues

➕ Additional context

https://github.com/actions/toolkit/blob/master/docs/problem-matchers.md

Action cannot find .mdlrc

👻 Brief Description

This action cannot find the mdl config file, if .mdlrc is in the root of the repo. I've only tested this in feature branches, so the steps below refer to that use case. This is my first time using GitHub actions, rather than Travis or GitLab CI, so possibly this is user error... 😭

🥞 Action version

master@fc56786

🎩 workflow configuration

name: markdownlint
on: [pull_request]
jobs:
    markdownlint:
        runs-on: ubuntu-latest
        steps:
        - name: Check out code
          uses: actions/checkout@v2
          with:
              ref: ${{ github.event.pull_request.head.sha }}
        - name: Run mdl
          uses: actionshub/markdownlint@master

Steps To Reproduce

Steps to reproduce the behavior:

1. Create a new, blank repo containing a Markdown file with some very long lines
2. Enable third party actions on the new repo.
3. Create a pull request and add the above workflow and this .mdlrc file in the root of the repo:

# All rules on by default.
all
# Extend line length.
rule 'MD013', :line_length => 99999
# Allow multiple headers with same content.
exclude_rule 'MD024'

The action will complain about overlong lines (violations of MD013).

🚓 Expected behavior

Given all the above, the action should pass on the feature branch.

➕ Additional context

Related to #7 which was resolved by adding some docs to the README in this repo. 📜

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

• chore(deps): update actionshub/reusable-workflows digest to 9973872
• chore(deps): update ruby docker tag to v3.3.4

Detected dependencies

bundler

Gemfile

• mdl undefined

dockerfile

Dockerfile

• ruby 3.2.2-slim

github-actions

.github/workflows/publish.yml

• actionshub/reusable-workflows cce19fb345836ccd29168d876a8a8eca454fb27a

.github/workflows/pull_request.yml

• actionshub/reusable-workflows cce19fb345836ccd29168d876a8a8eca454fb27a

---

• Check this box to trigger a request for Renovate to run again on this repository

Docker pull from ghcr not working for v2.1.1

👻 Brief Description

Using dependabot, the package was updated to new release v2.1.1 Unfortunately, the checkout from ghcr does not work:

/usr/bin/docker pull ghcr.io/actionshub/markdownlint:v2.1.1
Error response from daemon: manifest unknown

🥞 Action version

v2.1.1

🎩 workflow configuration

/usr/bin/docker pull ghcr.io/actionshub/markdownlint:v2.1.1

Steps To Reproduce

Steps to reproduce the behavior:

1. Pull v2.1.1 from ghcr