Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create ZWE message analysis workflow #4174

Merged
merged 16 commits into from
Feb 6, 2025

Conversation

MarkAckert
Copy link
Member

This PR introduces an automated workflow designed to help us detect discrepancies in ZWE end-user messages through simple analysis of zwe sources and .errors files present in the zwe command subdirectories. If we want to further improve message consistency from this point, rather than making the automation more sophisticated we should probably discuss refactoring how messages are defined and accessed from ZWE itself.

The automation will identify the following issues with high confidence, causing the workflow to fail:

  • Duplicate Message IDs defined in .errors files
  • Messages which are used in ZWE but not defined in .errors files, and therefore not present in docs site.
  • Message which are defined in .errors but never used in source code

The automation will identify with lower confidence:

  • Messages whose content in source files does not match their definition in .errors files

All the issues are output in the workflow's log.

Signed-off-by: MarkAckert <[email protected]>
Signed-off-by: MarkAckert <[email protected]>
Signed-off-by: MarkAckert <[email protected]>
@MarkAckert MarkAckert merged commit 37af882 into v3.x/staging Feb 6, 2025
10 of 11 checks passed
@MarkAckert MarkAckert deleted the user/markackert/message-automation branch February 6, 2025 14:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Build: None Used in CI
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants