CircleCI Partner Review

[KyleTryon]

Hello Muuklabs team 👋

I am Kyle from the @CircleCI team, thank you for submitting your orb! I have reviewed the orb contents and left some items for your review below.

• [x] README

  • Update the contents of the README file to reflect the orb name, description, etc.

• [x] Source_URL

  • Ensure the source_url in @orb.yml points to this repo.
  • https://github.com/muuklabs/circleci-orb/blob/7863f09d3b11ab8a230501c7aeba1744982fd90d/src/%40orb.yml#L8

• [x] Description

  • The orb description is vital to the SEO and discoverability of the orb on and off the platform. Consider adding a detailed description, ideally around 250 characters. Use keywords which describe the specific solutions your product provides to problems users may be searching for.
  • https://github.com/muuklabs/circleci-orb/blob/7863f09d3b11ab8a230501c7aeba1744982fd90d/src/%40orb.yml#L4

• [x] Examples

  • Rename your example to describe the use-case being shown
  • https://github.com/muuklabs/circleci-orb/blob/master/src/examples/example.yml
  • https://circleci.com/docs/2.0/orbs-best-practices/#examples
  • The contents of the example itself looks great 👍

• [x] Jobs

  • The description of the mkcli job describes itself as an executor. I think we mean to say the job is executed on the muuktest docker image.
  • The proper CircleCI spelling is CircleCI without a space. (In the description)
  • Understanding the job source
    • Being unfamiliar with Muuklabs, could you explain to me the run step within this job? I see muuklabs/executor is cloned and the videoEnabled branch appears to be checked out.
    • Are these required artifacts to run the job? Might we not expect these to be included with the Docker image?
    • Usually on CircleCI it is typical for the first step to be checkout which will clone the user's code into the environment. Does this job not require the user's code?
    • Are any artifacts expected? https://circleci.com/docs/2.0/artifacts/
    • Or test results? https://circleci.com/docs/2.0/collect-test-data/

• [x] Tests

  • All orbs must be tested. Both to ensure that future updates will not cause unexpected issues and to ensure the orb is working prior to launch.
  • The integration test that came with the orb development kit has not yet been modified and is currently only testing that code can be checked out: https://app.circleci.com/pipelines/github/muuklabs/circleci-orb/19/workflows/d6e70a5d-ce3a-4dc7-a2c5-eef11564cd27/jobs/45
  • The mkcli job must be tested in the integration-test_deploy workflow
    • https://github.com/muuklabs/circleci-orb/blob/7863f09d3b11ab8a230501c7aeba1744982fd90d/.circleci/config.yml#L63
    • Since this orb does not currently contain any commands, the integration-test-1 example test can be removed from the config and workflow.

[napoles-mk]

@KyleTryon thanks for your feedback, I have pushed changes as needed (still pending Tests part).

About your questions on Jobs; muuklabs/executor is cloned out of the docker image in order to maintain the latest version of the executor. The executor is a python cli which connects with muuktest.com to get the tests for certain organization, download, execute them on the selected browser inside the container and then return execution results to the muuktest portal. The tests are on muuktest portal and configured there, these tests are already pointing to an environment where new code is being deployed; so no need to checkout users code for our muuktest image.

[napoles-mk]

Hi @KyleTryon, I have also added a test for out orb on deployment so new source version is ready, please take a look and let me know any concerns.