New User Guides, Script Annotations and more in 5.7.0!

[elliotgunton]

Hera V5.7.0 is out!

We've rearranged the docs website to aid discovery of various things, including the brand new User Guides! In here, you'll find the core concepts of Hera, a deep-dive on the Script class, and the expr module guide (which was moved in).

A huge enhancement (special thanks to @dejamiko! 🎖) has been made to Scripts through annotations (i.e. Python's typing.Annotated), which are a new opt-in experimental feature to make your @script functions easier to write and less error prone, and includes some really cool auto-loading features when used with the Hera Runner. This means a script using an Artifact such as:

@script(inputs=Artifact(name="my-artifact", path="/tmp/file"))
def read_artifact():
    with open("/tmp/file") as a_file:  # Repeating "/tmp/file" is prone to human error!
        print(a_file.read())

Can now be written as:

@script(constructor="runner")
def read_artifact(an_artifact: Annotated[Path, Artifact(name="my-artifact", path="/tmp/file")]):
    print(an_artifact.read_text())

Or even directly loaded to a Pydantic type!

class MyArtifact(BaseModel):
    a = "a"
    b = "b"

@script(constructor="runner")
def read_artifact(
    an_artifact: Annotated[MyArtifact, Artifact(name="my-artifact", path="/tmp/file", loader=ArtifactLoader.json)]
) -> str:
    return an_artifact.a + an_artifact.b

Read more in the new Scripts guide!

There were also various bug fixes, new examples and doc improvements made - see the release notes.

Get a first look at announcements in our #hera slack channel on CNCF