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

Add sanity check Github Action for Executive Votes #2542

Merged
merged 4 commits into from
Feb 5, 2024

Conversation

0xldr
Copy link
Collaborator

@0xldr 0xldr commented Jan 26, 2024

This GitHub Action automates the validation of markdown files within the governance/votes folder. It is triggered upon the creation of pull requests, ensuring adherence to predefined standards and structure. Key features include:

  1. Automated Validation on Pull Requests:

    • The action is triggered whenever a pull request modifies markdown files in the governance/votes folder, ensuring that changes are reviewed for compliance with established standards.
    • It is able to validate multiple files, in the unlikely event that a Pull Request is editing multiple files within this folder.
  2. Comprehensive Checks:

    • The action validates several aspects of the markdown files' metadata, including the presence of essential metadata fields such as title, summary, and date.
    • It verifies the format and checksum of Ethereum addresses for the address field, ensuring they are valid. An exception is made for the placeholder "$spell_address", which is recognized as a valid temporary placeholder.
  3. Feedback via Comments:

    • If any issues are detected, the action posts a comment on the pull request, listing the specific validation errors for each file.
    • If no issues are found, it confirms successful validation, indicating that the markdown files meet the necessary criteria.

This is a fix for #2541


Examples

0xldr added 3 commits January 25, 2024 23:14
* Create validate_markdown.yml

* Create validate_markdown.py

* Update validate_markdown.py

* Update validate_markdown.yml

* Update validate_markdown.py

* Update validate_markdown.py

* fix web3 method names

* add skip for $spell_address
Copy link
Collaborator

@MakerJanSky MakerJanSky left a comment

Choose a reason for hiding this comment

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

Thank you, ldr.

@0xldr 0xldr merged commit c7a11d6 into makerdao:master Feb 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants