diff --git a/.github/workflows/linkcheck.yml b/.github/workflows/linkcheck.yml new file mode 100644 index 00000000..e8103666 --- /dev/null +++ b/.github/workflows/linkcheck.yml @@ -0,0 +1,25 @@ +# This is a basic workflow to help you get started with link checks in md files + +name: Check links in documentation + +# Controls when the workflow will run +on: + # Triggers the workflow on push or pull request events but only for the "main" branch + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + markdown-link-check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - uses: gaurav-nelson/github-action-markdown-link-check@v1 + with: + use-verbose-mode: 'yes' + file-extension: '.rst' diff --git a/README.rst b/README.rst index 9cd17748..6ca37dd2 100644 --- a/README.rst +++ b/README.rst @@ -309,3 +309,5 @@ provided by the bot. You will only need to do this once across all repos using o This project has adopted the `Microsoft Open Source Code of Conduct `_. For more information see the `Code of Conduct FAQ `_ or contact `opencode@microsoft.com `_ with any additional questions or comments. + +Add bogus [link](some link)