Skip to content

MDBF-1234: pull request submission trigger to verify the format - #2

Open
gkodinov wants to merge 1 commit into
mainfrom
mdbf-1234
Open

MDBF-1234: pull request submission trigger to verify the format#2
gkodinov wants to merge 1 commit into
mainfrom
mdbf-1234

Conversation

@gkodinov

@gkodinov gkodinov commented Aug 3, 2026

Copy link
Copy Markdown
Member

Implement a pull request submission trigger running when files in lists/ are changed to verify if their format is parseable.

Note that this PR is based on #1

@gkodinov
gkodinov marked this pull request as ready for review August 3, 2026 12:38
@gkodinov
gkodinov requested review from Copilot and vuvova August 3, 2026 12:39

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR introduces a GitHub Actions workflow that runs on pull requests affecting lists/** to validate that list files follow a parseable, consistent Markdown bullet/link format, and adds initial list files (reviewers, maintainers, committers).

Changes:

  • Added a pull_request workflow to detect changed files under lists/ and validate bullet/link formatting.
  • Added lists/reviewers.md, lists/maintainers.md, and lists/committers.md with GitHub profile links.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File Description
.github/workflows/check-lists-format.yml Adds the PR-triggered validation workflow for lists/** changes.
lists/reviewers.md Adds the reviewers list in Markdown bullet/link format.
lists/maintainers.md Adds the maintainers list in Markdown bullet/link format.
lists/committers.md Adds the committers list in Markdown bullet/link format.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/workflows/check-lists-format.yml
Comment thread .github/workflows/check-lists-format.yml
Comment thread .github/workflows/check-lists-format.yml
Comment thread .github/workflows/check-lists-format.yml

@vuvova vuvova left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks very complex. I thought it'd be a one-liner like

grep '^ *\* \+' lists/*|grep -v ': *\* \+\[[^]]\+\](https://github.com/.*)'

@vuvova vuvova left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

could it be simplified?

@gkodinov

Copy link
Copy Markdown
Member Author

could it be simplified?

It probably can be simplified. But what is the point?
I am confident it works as expected. And I like the extra verbosity.
Besides it's doing more or less the same, but in a loop and for each file separately:

            bullet_count=$(grep -cE "$BULLET_RE" "$file" || true)
            link_count=$(grep -cE "$LINK_RE"  "$file" || true)

            echo "File: $file"
            echo "  lines matching ^[[:space:]]*\*          : $bullet_count"
            echo "  lines matching the GitHub-link pattern  : $link_count"

            if [ "$bullet_count" -ne "$link_count" ]; then
              echo "::error file=$file::Bullet-line count ($bullet_count) does not equal properly-formatted GitHub-link count ($link_count)"
              FAIL=1
            else
              echo "  ? counts match"
            fi

@vuvova

vuvova commented Aug 11, 2026

Copy link
Copy Markdown
Member

I know it's doing more or less the same. But it's 40 lines instead of one and the reading speed is generally proportional to the number of lines. It's 40x more lines to read and understand. Only to arrive at conclusion that it's just a hand-coded grep|grep -v.

@gkodinov

Copy link
Copy Markdown
Member Author

I know it's doing more or less the same. But it's 40 lines instead of one and the reading speed is generally proportional to the number of lines. It's 40x more lines to read and understand. Only to arrive at conclusion that it's just a hand-coded grep|grep -v.

Alright. This is a stylistic thing, but there's no point in arguing if I want the job done. grep | grep -v it is.

@gkodinov
gkodinov requested a review from vuvova August 12, 2026 08:22
Implement a pull request submission trigger running when files in lists/ are
changed to verify if their format is parseable.

Co-authored-by: Grok:grok-4.5
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants