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

[CI] Enable CI and setup all logistics #14

Closed
wants to merge 8 commits into from
Closed

Conversation

adam2392
Copy link
Collaborator

@adam2392 adam2392 commented Aug 12, 2022

First step for #11

Summary for CI

We should keep CI and setup and installation workflow relatively similar. From my exp in OSS, this alleviates developer burden and overall technical debt.

This PR adds additional checks to the CI that are based off best practices:

  • circleCI will build documentation for every PR and commit to this repo
  • GH actions has a job to link output of circleCI to be linked to the checks
  • GH actions will test for style using poetry
  • GH actions will test for building the overall package
  • GH actions will run unit tests
  • GH actions will upload code coverage from unit tests
  • GH actions will also automatically release on pypi given a tag is made on main branch

TODO for CI:

  • GH actions should also weekly test integration suite. I.e. this will eventually encompass networkx, dowhy, pywhy_graphs and more.
  • ideally poetry doesn't install all dependencies for every single job it runs

Summary for repo docs

I've added more details to the README based on my experience. What would be nice is to extend the main figure in dowhy's README to encompass causal discovery. Otw, I think short READMEs are the way to go and then linking to the documentation.

Summary for code documentation

I've uploaded boiler plate documentation that will leverage the pydata sphinx layout. Inside we should track: contributors, and PRs. The API is also auto-rendered here via sphinx.

cc: @robertness

Comment on lines +43 to +45
- name: Install dependencies
run: poetry install

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Note @darthtrevino there is no way that I am aware of to only install what's needed for running the style checks. This ends up installing all dependencies right?

I think there is a fix coming up in v1.2 for poetry, but for now, I suppose this is fine since reading more, poetry does have a lot of nice properties.

@adam2392 adam2392 force-pushed the ci branch 2 times, most recently from acd7af0 to 956720f Compare August 12, 2022 18:24
darthtrevino and others added 8 commits August 12, 2022 14:34
Signed-off-by: Chris Trevino <chtrevin@microsoft.com>
Signed-off-by: Adam Li <adam2392@gmail.com>
Signed-off-by: Chris Trevino <chtrevin@microsoft.com>
Signed-off-by: Adam Li <adam2392@gmail.com>
Signed-off-by: Chris Trevino <chtrevin@microsoft.com>
Signed-off-by: Adam Li <adam2392@gmail.com>
Signed-off-by: Chris Trevino <chtrevin@microsoft.com>
Signed-off-by: Adam Li <adam2392@gmail.com>
Signed-off-by: Adam Li <adam2392@gmail.com>
Signed-off-by: Adam Li <adam2392@gmail.com>
Signed-off-by: Adam Li <adam2392@gmail.com>
Signed-off-by: Adam Li <adam2392@gmail.com>
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