Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make markdown-lint a required CI check #10058

Closed
hcgatewood opened this issue Nov 3, 2021 · 2 comments
Closed

Make markdown-lint a required CI check #10058

hcgatewood opened this issue Nov 3, 2021 · 2 comments
Labels
status: accepted type: proposal Proposals and design documents

Comments

@hcgatewood
Copy link
Contributor

Make markdown-lint a required CI check

The check has been active for 1+ months, and has support parity with the other required checks.

The win here is automatically enforcing a minimal set of Markdown standards -- only catches actual issues, is not meant to be intrusive 🙂

Job ref:

# Fail if Markdown doesn't pass linter
markdown-lint:
needs: path_filter
if: ${{ needs.path_filter.outputs.should_not_skip == 'true' }}
name: Markdown lint check
runs-on: ubuntu-latest
env:
MAGMA_ROOT: "${{ github.workspace }}"
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
python-version: '3.7'
- name: Run docs precommit
run: |
cd ${MAGMA_ROOT}/docs
make precommit

@hcgatewood hcgatewood added the type: proposal Proposals and design documents label Nov 3, 2021
@hcgatewood
Copy link
Contributor Author

cc @themarwhal

@themarwhal
Copy link
Member

I made this required some time ago :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: accepted type: proposal Proposals and design documents
Projects
None yet
Development

No branches or pull requests

2 participants