Skip to content

NEW workflow: WordPress.org README.md validation#811

Merged
mauteri merged 2 commits intoGatherPress:mainfrom
carstingaxion:feature/wp-org-readme-validator
Aug 25, 2024
Merged

NEW workflow: WordPress.org README.md validation#811
mauteri merged 2 commits intoGatherPress:mainfrom
carstingaxion:feature/wp-org-readme-validator

Conversation

@carstingaxion
Copy link
Copy Markdown
Collaborator

@carstingaxion carstingaxion commented Aug 20, 2024

This PR introduces a new README validation workflow and a subtle fix to the existing readme.

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.

Description of the Change

I had the feeling, that the readme.md is rendered weird on GitHub, so I looked for a validation and found this action.

The screenshots proofed my unclear feeling.

BEFORE AFTER
IMG_0209 IMG_0210

Closes #

How to test the Change

Changelog Entry

Fixed - White space issues in readme.md (including a new automated test)

Credits

Props @carstingaxion

Checklist:

  • I agree to follow this project's Code of Conduct.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests pass.

@carstingaxion carstingaxion marked this pull request as ready for review August 23, 2024 08:13
Stable tag: 0.30.0
Tested up to: 6.6.1
License: GPL v2 or later
Tags: events, event, meetup, community
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why this was changed, seems it's adding extra white space after text on lines 3 thru 6.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can the PR description maybe answer your question?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because this is intentional and exactly by purpose of this PR.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I see, yes, sorry.

Issue I think might be that a lot of IDEs are set to remove extra trailing white space. Let me check out the branch later and test that. If it's an issue we can test another way of doing same thing.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, this is fine. Just tested. Nice job!

@mauteri mauteri merged commit 2d34ea4 into GatherPress:main Aug 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants