Skip to content

Validate README.md markdown table in CI #105

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.

Sign up for GitHub

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

Jump to bottom
Merged
ahelwer merged 1 commit into from
Jan 18, 2024
Merged

Validate README.md markdown table in CI #105

ahelwer merged 1 commit into from
Jan 18, 2024

Conversation

@ahelwer
Copy link
Collaborator

@ahelwer ahelwer commented Jan 17, 2024 •
edited
Loading

  • Added python script to parse & validate README spec table against manifest.json, to run during CI
  • Split specs not included in this repo into a separate table
  • Remove number, Description, and External Modules columns
  • Added detail to Name column and added Beginner flag column
  • Added missing specs to table
  • Added missing feature flags to table
  • Added missing authors to table
  • Reordered specs to beginner-friendly specs with more feature flags are near the top

Closes #70

@ahelwer
Subjected README.md spec table to CI validation
58906ab 
Simplified & expanded spec table

Signed-off-by: Andrew Helwer <[email protected]>
@ahelwer ahelwer merged commit ab9049a into tlaplus:master Jan 18, 2024
@ahelwer ahelwer deleted the check-markdown branch January 18, 2024 14:05
@ahelwer ahelwer mentioned this pull request Jan 18, 2024
Open
@ahelwer ahelwer mentioned this pull request May 21, 2025
Open
@ahelwer ahelwer mentioned this pull request Jul 31, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Enforce correspondence between manifest.json and README.md table in CI

1 participant

@ahelwer