Extra args to om ci

[shivaraj-bh]

Internally @ Juspay, we use a flake input as a flag (flips between fast/slow-but-production-ready build), that is set to https://github.com/boolean-option/true by default and on specific production branches it is flipped using --override-input.

I will be writing two proposals to support this in Vira:

1. Extra args to om ci (see next sections for the proposal)
2. Extra args on a given branch name

Requirement [1]

Vira should be able to run om ci with extra arguments:

om ci run -- --override-input local github:boolean-option/false

Proposed solution (omnix)

Note

This solution may be skipped; as the proposed solutions for vira below supports arbitrary extra-arguments to om ci

Change omnix to convert the above CLI to

om ci run .#production

i.e., encode all the CLI args to om ci run in om.yaml itself.

For the command from "Original requirement", the om.yaml will be:

ci:
  production:
    project:
      dir: .
      overrideInputs:
        local: "github:boolean-option/false”

Proposed solution 1 (vira)

Add CLI args to Vira for specifying repo specific om ci settings:

--om-ci-repo-clone-url [REPO_CLONE_URL]
--om-ci-repo-extra-args [EXTRA_ARGUMENTS]

Example

vira --clone-urls "ssh://git@bitbucket.org/team/project.git,ssh://git@bitbucket.org/team/project1.git,ssh://git@bitbucket.org/team/project2.git" --om-ci-repo-clone-url "ssh://git@bitbucket.org/team/project.git" --om-ci-extra-args ".#production" --om-ci-repo-clone-url "ssh://git@bitbucket.org/team/project2.git" --om-ci-extra-args ".#production”

Con

Multiple occurences of [REPO_CLONE_URL] -- once in --clone-urls and optionally again in --om-ci-repo-clone-url.

Proposed solution 2 (vira)

Note: Based on Proposed solution 1 (vira)

Merge om ci and repo settings to avoid specifying [REPO_CLONE_URL] twice:

--clone-urls is replaced with `many` --repo-clone-url [REPO_CLONE_URL]
--repo-om-ci-extra-args [OM_REF]

Example

vira --repo-clone-url "ssh://git@bitbucket.org/team/project.git" --repo-om-ci-extra-args ".#production" --repo-clone-url "ssh://git@bitbucket.org/team/project2.git" --repo-om-ci-extra-args ".#production" --repo-clone-url "ssh://git@bitbucket.org/team/project2.git”

Con

Tightly couples vira with omnix

Proposed solution 3 (vira)

Support --config-path argument in Vira that encodes all the project-specific configurations.

Example

vira:
  repositories:
    project:
      clone-url: "ssh://git@bitbucket.org/team/project.git”
      om-ci-extra-args: ".#production”
    project2:
      clone-url: "ssh://git@bitbucket.org/team/project2.git”
      om-ci-extra-args: ".#production”

[srid]

@shivaraj-bh Your latest edit re: "Requirements" and the 4 "Proposed solution"s make all of this very clear, great!

Regarding "Proposed solution 3 (vira)", I've opened the more general #59 - we can discuss configuration vs convention over at #59 (are there other use cases configuration will address?).

[srid]

Without having thought about this in full, I'm veering towards either

• Proposed solution (omnix)

or

• Proposed solution 3 (vira)

Probably the later.

(I'm not keen on complicating the CLI; in fact, I want to move the existing args to vira configuration file or web GUI state at some point; see #59 (comment)).