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

Update update_documentation.yml #502

Merged
merged 3 commits into from
Apr 4, 2023
Merged

Conversation

Prasanna-Ponnusamy
Copy link
Collaborator

Please recheck if I added the right path

Describe your changes here:

All these boxes must be checked by the reviewers before merging the pull request:

As a reviewer please read through all the code lines and make sure that the code is fully understood, bug free, well-documented and well-structured.

  • The author added a BSD statement to doc/ (or already has one)

  • The code compiles without warning in debugging and release mode, with and without MPI (this should be executed automatically in a github action)

    If the Pull request introduces code that is not covered by the github action (for example coupling with a new library):

    • Should this use case be added to the github action?
    • If not, does the specific use case compile and all tests pass (check manually)
  • All tests pass (in various configurations, this should be executed automatically in a github action)

  • New source/header files are properly added to the Makefiles

  • New Datatypes are added to t8indent_custom_datatypes.txt

  • The reviewer executed the new code features at least once and checked the results manually

  • The code is covered in an existing or new test case

  • New tests use the Google Test framework

  • The code follows the t8code coding guidelines

  • The code is well documented

  • All function declarations, structs/classes and their members have a proper doxygen documentation

  • All new algorithms and data structures are sufficiently optimal in terms of memory and runtime (If this should be merged, but there is still potential for optimization, create a new issue)

  • If a new directory with source-files is added, it must be covered by the script/find_all_source_files.scp to check the indentation of these files.

  • If this PR introduces a new feature, it must be covered in an example/tutorial and a Wiki article.

Please recheck if I added the right path
Copy link
Collaborator

@sandro-elsweijer sandro-elsweijer left a comment

Choose a reason for hiding this comment

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

Please do the change also here:
https://github.com/DLR-AMR/t8code/blob/main/.github/workflows/add_release_documentation.yml#L125
We have one Workflow to upload the latest documentation of the main branch and one workflow to add a documentation if a new major or minor release takes place. Both are affected.

@Prasanna-Ponnusamy
Copy link
Collaborator Author

Thank you Sandro!

@Prasanna-Ponnusamy Prasanna-Ponnusamy marked this pull request as ready for review April 4, 2023 12:38
Copy link
Collaborator

@sandro-elsweijer sandro-elsweijer left a comment

Choose a reason for hiding this comment

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

lgtm

@sandro-elsweijer sandro-elsweijer merged commit 70f155d into main Apr 4, 2023
@sandro-elsweijer sandro-elsweijer deleted the Prasanna-Ponnusamy-patch-1 branch April 4, 2023 12:50
jfussbro pushed a commit to jfussbro/t8code that referenced this pull request Jun 27, 2023
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.

2 participants