فایل های Markdown که با پسوند md می باشند معمولا برای نوشتن راهنما و مستندات یک پروژه از آنها استفاده می شود که معمولا همه ی پروژه ها فایلی با نام README.md را شامل می شوند.
برای نوشتن یک فایل md می توان از یک Markdown linter استفاده کرد که در فرایند CI/CD به صورت خودکار فایل های md پروژه را بررسی و مشکلات آنها را نمایش دهد تا فایل های استانداردی داشته باشیم.
در این مطلب قصد داریم تا از ابزار markdown-lint در GitHub Action استفاده کنیم. برای اینکار کافیست تا تکه کد زیر را در GitHub Action خود اضافه کنید:
jobs:
markdown-lint:
runs-on: ubuntu-latest
steps:
- name: Checkout source code
uses: actions/checkout@v2
- name: Markdown Linting Action
uses: avto-dev/markdown-lint@v1.5.0
with:
args: './README.md'
همانطور که در مثال مشاهده می کنید. فایل README.md بررسی خواهد شد. نمونه کامل تنظیمات GitHub Action به صورت زیر می باشد:
name: CI
# 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:
jobs:
markdown-lint:
runs-on: ubuntu-latest
steps:
- name: Checkout source code
uses: actions/checkout@v2
- name: Markdown Linting Action
uses: avto-dev/markdown-lint@v1.5.0
with:
args: './README.md'
برای اطلاعات بیشتر و تنظیمات markdown-lint می توان پروژه ی آن را بر روی GitHub مشاهده کنید:
https://github.com/marketplace/actions/markdown-linting-action
امید است تا از این مطلب استفاده لازم را برده باشید.
