Skip to content

An action to validate the header section of your WordPress plugin is spaced correctly

License

Notifications You must be signed in to change notification settings

pantheon-systems/validate-readme-spacing

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

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'