search

NWChemEx / .github

GitHub Settings for the NWChemEx Organization
https://nwchemex.github.io/.github/
Apache License 2.0
1 stars 2 forks source link

CI architecture and usage documentation #36

Closed quazirafi closed 2 years ago

quazirafi commented 2 years ago

Added complete documentation of the CI architecture and usage of reusable CI components.

twindus commented 2 years ago

Hey @hjjvandam! Is this something that you think you can take him.

hjjvandam commented 2 years ago

@ryanmrichard I can take this on. I just need to get back into it.

ryanmrichard commented 2 years ago

@hjjvandam sounds good. The CI team is still hard at work, so at this point we really just you to: read through these notes, point out anything that's not clear, and let us know if you have any design/architecture questions.

CLAassistant commented 2 years ago

CLA assistant check
All committers have signed the CLA.

hjjvandam commented 2 years ago

In "ci_maintainer_notes.rst" there still are mentions of "test_docs.yaml" and "test_docs_tmpl.yml". I guess they should be "build_docs.yaml" and company?

ryanmrichard commented 2 years ago

@quazirafi I resolved a conflict, between this PR and master. You may want to take a quick look and make sure I resolved it correctly (basically we want your version and no part of the old one).

quazirafi commented 2 years ago

@quazirafi I resolved a conflict, between this PR and master. You may want to take a quick look and make sure I resolved it correctly (basically we want your version and no part of the old one).

I think you went back to the older documentation. @ryanmrichard

ryanmrichard commented 2 years ago

@quazirafi this is the state of the CI maintainer notes in the most recent commit to this PR. Quickly glancing through it, it looks like they are your notes (I don't see any of the old notes). Is this what you were looking at too?

quazirafi commented 2 years ago

@quazirafi this is the state of the CI maintainer notes in the most recent commit to this PR. Quickly glancing through it, it looks like they are your notes (I don't see any of the old notes). Is this what you were looking at too?

@ryanmrichard yes these are my notes. Actually I directly went to the documentation link. I guess that was not updated. So, I found the previous notes. Looks ok to me now.

twindus commented 2 years ago

Thanks @hjjvandam!

quazirafi commented 2 years ago

In "ci_maintainer_notes.rst" there still are mentions of "test_docs.yaml" and "test_docs_tmpl.yml". I guess they should be "build_docs.yaml" and company?

The repos that follow our architecture use deploy_docs.yaml and test_docs.yaml. And these workflows then call the callee workflows deploy_docs_tmpl.yml and test_docs_tmpl.yml of centralized .github repo. @hjjvandam

hjjvandam commented 2 years ago

In "ci_maintainer_notes.rst" there still are mentions of "test_docs.yaml" and "test_docs_tmpl.yml". I guess they should be "build_docs.yaml" and company?

The repos that follow our architecture use deploy_docs.yaml and test_docs.yaml. And these workflows then call the callee workflows deploy_docs_tmpl.yml and test_docs_tmpl.yml of centralized .github repo. @hjjvandam

OK, but this still is confusing. Under "LAYER OF CALLER WORKFLOWS (TOPMOST LAYER)" there are 4 YAML files listed. One of those is called "build_docs.yaml". But then a bit further down it says "d. test_docs.yaml calls test_docs_tmpl.yml template workflow with input target, dependencies and skip_doxygen." However, "test_docs.yaml" was never mentioned before. So is it possible that "build_docs.yaml" should really be "test_docs.yaml"?

quazirafi commented 2 years ago

In "ci_maintainer_notes.rst" there still are mentions of "test_docs.yaml" and "test_docs_tmpl.yml". I guess they should be "build_docs.yaml" and company?

The repos that follow our architecture use deploy_docs.yaml and test_docs.yaml. And these workflows then call the callee workflows deploy_docs_tmpl.yml and test_docs_tmpl.yml of centralized .github repo. @hjjvandam

OK, but this still is confusing. Under "LAYER OF CALLER WORKFLOWS (TOPMOST LAYER)" there are 4 YAML files listed. One of those is called "build_docs.yaml". But then a bit further down it says "d. test_docs.yaml calls test_docs_tmpl.yml template workflow with input target, dependencies and skip_doxygen." However, "test_docs.yaml" was never mentioned before. So is it possible that "build_docs.yaml" should really be "test_docs.yaml"?

@hjjvandam You are absolutely right. That was an error from me. Thanks for pointing this out. I corrected it. @ryanmrichard Maybe you need to merge this change too!

ryanmrichard commented 2 years ago

@quazirafi I'm not following what change needs to be merged? When you push commits to the branch the changes just gets tacked onto the end of the PR. The changes you pushed will be merged into master when the PR gets merged.

hjjvandam commented 2 years ago

I think this PR is ready to be merged now. @ryanmrichard Github seems to have selected you for a final review.