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 check_methoddoc_gen.yaml #19879

Merged
merged 16 commits into from
Oct 19, 2024
Merged

Conversation

markcmiller86
Copy link
Member

Description

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

Type of change

  • [ ] Bug fix
  • New feature~~
  • [ ] Documentation update
  • [ ] Other

How Has This Been Tested?

Reminders:

  • Please follow the style guidelines of this project.
  • Please perform a self-review of your code before submitting a PR and asking others to review it.
  • Please assign reviewers (see VisIt's PR procedures for more information).

Checklist:

  • I have commented my code where applicable.~~
  • [ ] I have updated the release notes.
  • I have made corresponding changes to the documentation.~~
  • [ ] I have added debugging support to my changes.
  • [ ] I have added tests that prove my fix is effective or that my feature works.
  • [ ] I have confirmed new and existing unit tests pass locally with my changes.
  • [ ] I have added new baselines for any new tests to the repo.
  • I have NOT made any changes to protocol or public interfaces in an RC branch.~~

@markcmiller86
Copy link
Member Author

markcmiller86 commented Oct 4, 2024

@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
Copy link
Member Author

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

Copy link
Member

@JustinPrivitera JustinPrivitera left a comment

Choose a reason for hiding this comment

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

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

@markcmiller86
Copy link
Member Author

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
Copy link
Member Author

@cyrush any qualms about merging this to develop?

@markcmiller86
Copy link
Member Author

This should wait until we decide upon #19881

@cyrush
Copy link
Member

cyrush commented Oct 7, 2024

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

@markcmiller86
Copy link
Member Author

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?

@markcmiller86 markcmiller86 merged commit ff0804a into develop Oct 19, 2024
5 checks passed
markcmiller86 added a commit that referenced this pull request Oct 19, 2024
markcmiller86 added a commit that referenced this pull request Oct 19, 2024
* Create check_methoddoc_gen.yaml (#19879)

* fix formatting
@markcmiller86 markcmiller86 deleted the mcm86-04oct24-methdoc-ci branch October 30, 2024 18:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants