Release 0.1.8 - Child Services and Documentation

[cortadocodes]

Contents

New Features

• Primary objective of this release is to enable use of children - solving Service Resource and interaction methods #46.

  • To solve Runner().run() method within parent twin: Avoid using 'app' as a python module, except for your main entrypoint #57 we need to be able to define and run local children as well as remote ones.
  • This means we must allow multiple services to run locally and independently...
  • Which probably means we can also solve App dependency / environment manager twined-server#2 at the same time

• Covers the Flow-Structure-Interaction use case in Demonstrate use of OpenFOAM in responding to a question #73

• Enable Documentation Build and Serve, Update README Update SDK readme and ensure that documentation gets served #70

  • Ultimately we wish to unify documentation between twined and octue-sdk-python, but this is best done at the time of refactoring large chunks of octue-sdk-python into twined ( See Consolidate Twined repository #69 ) but at the moment we wish to just serve what we've got so we can at least link to it.

• Progressive improvement of filtering by adding some additional filters (not all required by Complete field lookups #7, but some)

  • ...

• Add option to handle developer logs separately from Scientist logs (Feature: Add option to handle developer logs separately #78)

• Allow skipping of CI tests if #skip_ci_tests is in the commit body - the use case is to reduce unnecessary computation when knowing the tests will fail for a commit but still wanting to commit.

Minor fixes and improvements

• Implements a proper issue template, either derived from .github repo or applied directly (c.f. Update issue templates to multiple choice twined#60 )

• Close Clean up cli testing to avoid race conditions #32 - stop CLI tests leaving output files in working area.

Quality Checklist

• New features are fully tested (No matter how much Coverage Karma you have)
• [v0.2 onward] New features are included in the documentation

Coverage Karma

• If your PR decreases test coverage, do you feel you have built enough Coverage Karma* to justify it?

*Coverage Karma can be earned by disproportionally increasing test coverage in the rest of your contributions.
It's an honesty policy - you keep count of your own.

[codecov-io]

Codecov Report

Merging #68 (b273b5b) into main (5bcf2b7) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #68   +/-   ##
=======================================
  Coverage   96.30%   96.30%           
=======================================
  Files          40       40           
  Lines         839      839           
=======================================
  Hits          808      808           
  Misses         31       31           

---

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 5bcf2b7...b273b5b. Read the comment docs.