visit-dav / visit

VisIt - Visualization and Data Analysis for Mesh-based Scientific Data
https://visit.llnl.gov
BSD 3-Clause "New" or "Revised" License
444 stars 117 forks source link

Create check_methoddoc_gen.yaml #19879

Closed markcmiller86 closed 1 month ago

markcmiller86 commented 1 month ago

Description

Create GitHub action for checking MethodDoc.C is generated when functions.rst is changed.

Type of change

How Has This Been Tested?

Reminders:

Checklist:

markcmiller86 commented 1 month ago

@JustinPrivitera and @cyrush this adds CI for keeping functions.rst and MethodDoc.C in sync. It uses GitHub actions to do it so is run on different resources than Azure.

It would be nice to cancel the Main_Build if this action fails. Didn't look that far though.

markcmiller86 commented 1 month ago

BTW, you can introspect workflow runs by going to Actions tab.

markcmiller86 commented 1 month ago

I am guessing that the fix to methoddoc and functions was how you tested this?

Yes. Thats right. Along with various commits of whitespace (ws) changes to test different branches of the logic.

markcmiller86 commented 1 month ago

@cyrush any qualms about merging this to develop?

markcmiller86 commented 1 month ago

This should wait until we decide upon #19881

cyrush commented 1 month ago

I think we would want this both on RC and develop if possible.

markcmiller86 commented 1 month ago

I think we would want this both on RC and develop if possible.

Well, now I am inclined to wait until we resolve the email discussion...do we really need to keep MethodDoc.[Ch] in the repo anyways?

Thoughts?