Requirements

Requirements

Concepts / Resources

Familiarity with:

• Our contributing doc

• RunWhen Terms and Concepts

• Review our Code of Conduct

• Google python style guide; we generally try to follow it but do stray when needed for certain designs.

• Robot Framework, although a strong understanding of Robot is not needed. We try to handle complex logic at the python or external script level and use Robot like a configuration language, passing data and settings between Robot Tasks.

Development Environment

Authoring and testing CodeBundles requires:

• A Public GitHub Repository

• The ability to run a devcontainer image (e.g. via GitHub Codepaces, VSCode)

• Lab / test infrastructure; CodeBundles should be adequately tested against test infrastructure from the local environment prior to uploading to the RunWhen Platform Workspace for testing.

• A RunWhen Platform Workspace; for thorough testing, the RunWhen Platform (SaaS) service should be able to access the test infrastructure.

CodeCollection Development Image

The CodeCollection development image is specified in the devcontainer.json spec and is built from the local Dockerfile inside of the CodeCollection template repository. Developers can customize this Dockerfile as needed, though it can't guarantee that tools installed in this image will function properly within the SaaS platform and a conversation with our team on Slack may be required.

CodeCollection Development Image Layers