Skip to content
file-text

GitHub Action

WordPress Plugin README.md Validator

v1.0.5 Latest version

WordPress Plugin README.md Validator

file-text

WordPress Plugin README.md Validator

Checks a README.md file that uses the standard WordPress readme.txt plugin header format for valid markdown

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: WordPress Plugin README.md Validator

              
  uses: pantheon-systems/validate-readme-spacing@v1.0.5
Learn more about this action in pantheon-systems/validate-readme-spacing

Choose a version

Validate Readme Spacing

Testing MIT License

A GitHub Action that validates that the heading section of your plugin's README.md has newlines handled correctly.

When writing markdown, two spaces are required at the end of a line to preserve single line breaks in the rendered view. Some people's (@jazzsequence) IDEs helpfully remove these and the diff can be missed in GitHub's PR view.

Input

filepath

The path to the project's README file. Defaults to README.md.

Example Usage

uses: pantheon-systems/validate-readme-spacing@v1
with:
  filepath: 'README.md'