Skip to content

Identify message IDs that are missing documentation #141

@1000TurquoisePogs

Description

@1000TurquoisePogs

#140 improves message id documentation, but does not prevent new message IDs from missing documentation in the future.
How might we automate checks on that?

This ticket is to brainstorm the topic.
My thought:
#140 establishes a little formality that can be searched: given a message id like 0062E, you should see a line in the regex pattern of "^//@### ZWEL0062E$"
Perhaps a workflow that

  1. collects all lines in the form of "#define ... MSG_PREFIX "msgid"..."
  2. splits the line to get "msgid"
  3. checks for regex "^//@### msgid$"
  4. reports on which messages are missing, and if this is non-0, put a reject on the PR

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions