github-action-markdown-link-check

github-action-markdown-link-check copied to clipboard

If I set check-modified-files-only: true, the link checker ignores the folder-path I have set.

Here's the workflow:

link_checker:
  # https://github.com/gaurav-nelson/github-action-markdown-link-check
  runs-on: ubuntu-latest
  steps:
  - name: Checkout
    uses: actions/checkout@v2
    with:
      submodules: false
  - name: Check markdown links
    uses: gaurav-nelson/github-action-markdown-link-check@master
    with:
      config-file: .mlc_config.json
      # only check the docs folder
      folder-path: 'docs'
      use-quiet-mode: yes
      use-verbose-mode: yes
      check-modified-files-only: yes

This repository includes a bunch of old files that we're not publishing, in a folder called .unpublished. These files are bound to have dead links.

Sample run output. Note the FOLDER_PATH, and the very first file it checks:

Using markdown-link-check configuration file: .mlc_config.json
USE_QUIET_MODE: yes
USE_VERBOSE_MODE: yes
FOLDER_PATH: docs
MAX_DEPTH: -1
CHECK_MODIFIED_FILES: yes
FILE_EXTENSION: .md
FILE_PATH: 
BASE_BRANCH: master
From https://github.com/[redacted]
 * branch            master     -> FETCH_HEAD
 * [new branch]      master     -> origin/master
=========================> MARKDOWN LINK CHECK <=========================

FILE: .unpublished/events-08-19/functions/libraries.md
[✖] https://<servername removed>/docs/platform/functions/ → Status: 404

[...further lines removed...]

@polarweasel Could you report if this is still an issue with version 1.0.12 ?

same for file-path

@gaurav-nelson Figures, I just left that job this week :(

I will point a colleague to this issue and see if he can test!

@gaurav-nelson @polarweasel sorry it took so long, this is still an issue sadly

Thank @techwritermat I think I now understand what's going on, I'll try to resolve this.

Awesome! I'm about to start using this action at Yugabyte too, and I can guarantee we'll hit the same issue, so it'd be great to have this one resolved. :)

@gaurav-nelson any updates on this one?

@polarweasel Lately I've been busy with work. I was working on https://github.com/gaurav-nelson/github-action-markdown-link-check/pull/104 but didn't finish it. Right now I don't know when I can get back to this.