Update Zenodo DOI in README.md #247
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Markdown linting | |
| # This workflow is triggered on pushes and PRs to the repository. | |
| # It runs Markdown and YAML lint tests | |
| on: | |
| push: | |
| pull_request: | |
| release: | |
| types: [published] | |
| jobs: | |
| Markdown: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| - name: Install markdownlint | |
| run: npm install -g markdownlint-cli | |
| - name: Run Markdownlint | |
| run: markdownlint ${GITHUB_WORKSPACE} -c ${GITHUB_WORKSPACE}/.github/markdownlint.yml | |
| # If the above check failed, post a comment on the PR explaining the failure | |
| - name: Post PR comment | |
| if: failure() | |
| uses: mshick/add-pr-comment@v2 | |
| with: | |
| message: | | |
| ## Markdown linting is failing | |
| To keep the code consistent with lots of contributors, we run automated code consistency checks. | |
| To fix this CI test, please run: | |
| * Install `markdownlint-cli` | |
| * On Mac: `brew install markdownlint-cli` | |
| * Everything else: [Install `npm`](https://www.npmjs.com/get-npm) then [install `markdownlint-cli`](https://www.npmjs.com/package/markdownlint-cli) (`npm install -g markdownlint-cli`) | |
| * Fix the markdown errors | |
| * Automatically: `markdownlint . --config .github/markdownlint.yml --fix` | |
| * Manually resolve anything left from `markdownlint . --config .github/markdownlint.yml` | |
| Once you push these changes the test should pass, and you can hide this comment :+1: | |
| We highly recommend setting up markdownlint in your code editor so that this formatting is done automatically on save. Ask about it on Slack for help! | |
| Thanks again for your contribution! | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| allow-repeats: false |