mdolab / openconcept

OpenConcept: A toolkit for conceptual MDAO of aircraft with unconventional propulsion architectures
MIT License
36 stars 32 forks source link

Migrate to RTD and Codecov and update package version to 0.4.0 #34

Closed eytanadler closed 2 years ago

eytanadler commented 2 years ago

Purpose

With all the new work added (thermal management comps and OAS work), I updated the minor version. Once this is pushed, I plan to make a new release on GitHub as well. Let me know if there's anything I'm missing.

This PR also moves the documentation to the MDO Lab's read the docs and to codecov from coveralls.

Type of change

What types of change is it? Select the appropriate type(s) that describe this PR

coveralls commented 2 years ago

Pull Request Test Coverage Report for Build 1746261968


Files with Coverage Reduction New Missed Lines %
openconcept/analysis/openaerostruct/aerostructural.py 3 98.38%
<!-- Total: 3 -->
Totals Coverage Status
Change from base Build 1741637035: -0.05%
Covered Lines: 5303
Relevant Lines: 6069

💛 - Coveralls
bernardopacini commented 2 years ago

This looks good to me. Two general questions:

eytanadler commented 2 years ago

This looks good to me. Two general questions:

  • Now that your name is on the README, do you want to add it to the setup.py file as well? I think it would make sense since you are now the main maintainer and have contributed consequential parts to the code (if I am not mistaken with either statement).

Good idea, will do.

  • Is this still "pre-release" since the number is less than 1.0? What would constitute a "first version"?

I'm thinking once we update the docs to make them more complete? Hopefully that happens before I graduate.

Hannah also suggested maybe moving to the MDO Lab's read the docs and from coveralls to codecov, which I think is a good idea so it's consistent with the rest of the mdolab repos. Thoughts?

bernardopacini commented 2 years ago
  • Is this still "pre-release" since the number is less than 1.0? What would constitute a "first version"?

I'm thinking once we update the docs to make them more complete? Hopefully that happens before I graduate.

Hannah also suggested maybe moving to the MDO Lab's read the docs and from coveralls to codecov, which I think is a good idea so it's consistent with the rest of the mdolab repos. Thoughts?

Sounds good to me! I agree with moving to the MDO Lab pages / pipelines to unite this with our other repos. Let me know if you need help doing this, I have set up a few RTD pages for us at this point. Since this package does not rely on MACH I think we can leave it on GH Actions, which simplifies things.

codecov[bot] commented 2 years ago

Codecov Report

:exclamation: No coverage uploaded for pull request base (master@697fb9c). Click here to learn what that means. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master      #34   +/-   ##
=========================================
  Coverage          ?   87.76%           
=========================================
  Files             ?       47           
  Lines             ?     6095           
  Branches          ?        0           
=========================================
  Hits              ?     5349           
  Misses            ?      746           
  Partials          ?        0           

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 697fb9c...60f361d. Read the comment docs.

eytanadler commented 2 years ago

Overall this is fine, see comments below. Also, there are now two separate docs builds, we probably want to disable the .org one

I'm planning on getting in touch with Ben to get that done. As far as I know, he's the only one with access.