Added checking markdown links

[shenoynikhil]

Before submitting

Based on the Lightning-AI/pytorch-lightning#16168, added workflow files for checking markdown links.

• Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
• Did you read the contributor guideline, Pull Request section?
• Did you make sure to update the docs?
• Did you write any new necessary tests?

What does this PR do?

Fixes #80.

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃

[shenoynikhil]

@akihironitta I guess I need some approval to run workflows.

[Borda]

@akihironitta I think we shall describe in the readme that check- are meant to be a re-usable workflow and ci- to run for the particular repo

[shenoynikhil]

I think I need to update the config json to allow for skipping CHANGELOG links.

[akihironitta]

Thanks! LGTM! In this PR or in a follow-up PR, could you call this reusable workflow from ci-use-checks.yml? This way, we know the new workflow actually works :)

[akihironitta]

It seems like one of the links returns 404. Mind resolving the error in this PR? Just marked this PR as draft so that we don't accidentally merge this PR into master. Once it's fixed, please mark this PR as ready!

[shenoynikhil]

So it fails in the main README where the docs is currently showing unknown. The link attached is,
https://lightning-tools.readthedocs.io/en/latest/?badge=latest
I couldn't find the correct link. Could you share the correct one?

[akihironitta]

@shenoynikhil Oh sorry this is the correct one! https://lightning-devtools.readthedocs.io/en/latest/

@Borda We might want to update the domain to something like lightning-utilities.readthedocs.io. What do you think?

[shenoynikhil]

Should I use the one you have shared for now?

[shenoynikhil]

I updated the README with the link you shared. I guess whenever the domain changes, the README.md will also change accordingly.

[akihironitta]

@shenoynikhil Thanks! Overall looks good but looking at it again, it has to be a reusable workflow. (ref) Examples we have are named .github/workflows/check-*.yml. Sorry I'll be away from keyboard now. Let me have another look at this tomorrow!

[akihironitta]

Requesting changes just for me to remind myself of coming back to this PR :)

[shenoynikhil]

Thank you so much!

[Borda]

We might want to update the domain to something like lightning-utilities.readthedocs.io. What do you think?

renamed as https://lit-utilities.readthedocs.io/en/latest/

[akihironitta]

Sorry for the delay! Thank you for working on this :)

[Borda]

hi @akihironitta @shenoynikhil what is missing to land this? :)

[akihironitta]

Hi @shenoynikhil! Mind having a look at my comment above? If you're too busy to finish this, I can contribute to this by directly pushing commits to your branch as a weekend project (if you're fine with it) 🚀

[Borda]

if we g with workflow_call then this shall be input argument
also I would consider to make this file on the fly (dump to the CI run) if none is provided 🐿️

[shenoynikhil]

That makes sense, did the first part. Will have to think about how to do the second bit. Based of initial ideas (ignore my github workflow building skills), would the jobs part of the workflow look like this,

jobs:
  markdown-link-check:
    runs-on: ubuntu-20.04
    steps:    
    - uses: actions/checkout@master
    - name: Check for config file, if not create it
      run: |
        if [ ! -f ${{ inputs.config-file }} ]; then
          echo "config.json not found, creating one..."
          echo '{
              "ignorePatterns": [
                {
                  "pattern": "^https://github.com/Lightning-AI/lightning/pull/.*"
                }
              ],
              "httpHeaders": [
                {
                  "urls": ["https://github.com/", "https://guides.github.com/", "https://help.github.com/", "https://docs.github.com/"],
                  "headers": {
                    "Accept-Encoding": "zstd, br, gzip, deflate"
                  }
                }
              ]
            }' > ${{ inputs.config-file }}
        else
          echo "config.json found, no need to create one."
        fi
    - uses: gaurav-nelson/github-action-markdown-link-check@v1
      with:
        use-quiet-mode: 'yes'
        config-file: ${{ inputs.config-file }}

[Borda]

@akihironitta ^^

[Borda]

@akihironitta ^^ 🐿️

done