Feat: release v2.10. - Adds support for docs

[dapineyro]

Overview

This PR implements the new parameter --workflow-docs-link for the workflow import command, to be able to link docs in CloudOS.

Changes

• Adds new parameter --workflow-docs-link
• Updates CHANGELOG.md, README.md and _version.py
• Bumps version to v2.10.0
• Updates Pytest adding the new parameter to the relevant test
• New docker image available (v2.10.0)

Tests

The following tests are performed on https://dev.sdlc.lifebit.ai, which is the only CloudOS with the feature enabled as of today.

Running docker image:

docker run --rm -it quay.io/lifebitaiorg/cloudos-cli:v2.10.0

Calling the in-built help:

cloudos workflow import --help
CloudOS python package: a package for interacting with CloudOS.

Version: 2.10.0

CloudOS workflow functionality: list and import workflows.

Usage: cloudos workflow import [OPTIONS]

  Imports workflows to CloudOS.

Options:
  -k, --apikey TEXT               Your CloudOS API key  [required]
  -c, --cloudos-url TEXT          The CloudOS url you are trying to access to.
                                  Default=https://cloudos.lifebit.ai.
  --workspace-id TEXT             The specific CloudOS workspace id.
                                  [required]
  --workflow-url TEXT             URL of the workflow to import. Please, note
                                  that it should be the URL shown in the
                                  browser, and it should come without any of
                                  the .git or /browse extensions.  [required]
  --workflow-name TEXT            The name that the workflow will have in
                                  CloudOS  [required]
  --workflow-docs-link TEXT       Workflow documentation URL.
  --repository-project-id INTEGER
                                  The ID of your repository project
                                  [required]
  --repository-id INTEGER         The ID of your repository. Only required for
                                  GitHub repositories
  --disable-ssl-verification      Disable SSL certificate verification.
                                  Please, remember that this option is not
                                  generally recommended for security reasons.
  --ssl-cert TEXT                 Path to your SSL certificate file.
  --help                          Show this message and exit.

Setting up variables:

MY_API_KEY="xxxx"
CLOUDOS="https://dev.sdlc.lifebit.ai"
WORKSPACE_ID="xxxx"

Import a GitHub pipeline with docs

 cloudos workflow import \
    --cloudos-url $CLOUDOS \
    --apikey $MY_API_KEY \
    --workspace-id $WORKSPACE_ID \
    --workflow-url $WORKFLOW_URL \
    --workflow-name "test_import_github_5" \
    --workflow-docs-ling "https://link/to/repo/docs.md" \
    --repository-project-id $REPOSITORY_PROJECT_ID \
    --repository-id $REPOSITORY_ID

CloudOS python package: a package for interacting with CloudOS.

Version: 2.10.0

CloudOS workflow functionality: list and import workflows.

Executing workflow import...

	[Message] Only Nextflow workflows are currently supported.

	Workflow test_import_github_5 was imported successfully with the following ID: 6618002f14e3c77096efc6f8

Import a GitHub pipeline without docs (default)

 cloudos workflow import \
    --cloudos-url $CLOUDOS \
    --apikey $MY_API_KEY \
    --workspace-id $WORKSPACE_ID \
    --workflow-url $WORKFLOW_URL \
    --workflow-name "test_import_github_6" \
    --repository-project-id $REPOSITORY_PROJECT_ID \
    --repository-id $REPOSITORY_ID

CloudOS python package: a package for interacting with CloudOS.

Version: 2.10.0

CloudOS workflow functionality: list and import workflows.

Executing workflow import...

	[Message] Only Nextflow workflows are currently supported.

	Workflow test_import_github_6 was imported successfully with the following ID: 661802f614e3c77096effea8