[semver:major] Orb Tools Orb v10

[gmemstr]

Orb Pack v10

A number of large orb updates are coming! In preparation, we are looking to create a new v10 version of the Orb-Tools-Orb reimagined with some changes we have been working on, while also giving us a chance to clean up and reorganize the orb.

The primary focus of this change is around the new circleci orb pack cli command currently in beta in the CircleCI CLI. Read more here: https://discuss.circleci.com/t/circleci-cli-orb-pack-beta/36598

The orb pack command will replace (but not remove!) the config pack command for the purposes of creating orbs. The major benefit being you may now import files directly into your config! This means you can write your bash shell scripts as bash scripts and import them into the command section of a config. This opens up many opportunities for local execution and testing.

Added:

• Added src/scripts folder with each script command.
• BATS testing for more complex scripts.
• New usage example, to be used in an upcoming orb init command.

Changed:

• Convert executors to use new cimg docker images.
• Complex commands now import their scripts using the new <<include()>> feature from orb pack.

Removed:

• Removed many unnecessary executors for Orb Tools.
• Shellcheck job
• check-env-var-parameters

[KyleTryon]

Consider for removal:

• check-env-var-param https://github.com/CircleCI-Public/orb-tools-orb/blob/orb-pack-10/src/commands/check-env-var-param.yml
  • Appears to not be used in the orb but offered as some kind of utility command.
  • Trying to remove "utility" commands from the final UI usage of the orb, ultimately limiting the noise of how many steps are used. These utility processes should be built-in or imported into the command script.
• local-test-build
  • https://github.com/CircleCI-Public/orb-tools-orb/blob/orb-pack-10/src/commands/local-test-build.yml
  • https://github.com/CircleCI-Public/orb-tools-orb/blob/orb-pack-10/src/jobs/test-in-builds.yml
  • A potential way to locally, when running on CircleCI though we can truly test the job and run BATS tests.

Consider for change:

• Shellcheck https://github.com/CircleCI-Public/orb-tools-orb/blob/orb-pack-10/src/jobs/shellcheck.yml
  • Currently shellchecks the commands directly which has been error-prone. Change to shellcheck true .sh files (in the script folder only?) now that orb pack exists.

[gmemstr]

@KyleTryon https://github.com/CircleCI-Public/orb-tools-orb/blob/orb-pack-10/src/scripts/shellcheck.sh does shellchecking of both the scripts folder as well as the YAML strings, but I'd be okay with dropping the YAML extraction.

I'm okay with removing the local-test-build, and probably move the check-env-var-param to build-tools - I can see it's utility being useful. But we can drop it if we think it's ultimately useless.

[KyleTryon]

Removed local-test-build.

May be useful for local testing, but as the orb is in the cloud, there doesnt seem to be any reason to run "local" tests, on the cloud. Integration tests would be preferred here.

Thoughts @gmemstr @lokst ? https://github.com/CircleCI-Public/orb-tools-orb/pull/90/commits/1a0f2ac24470109c9c632f4a7a61b0cab78018d2

[gmemstr]

@KyleTryon Makes sense - with the new orb testing standards (prefering actual language testing frameworks over extracting from YAML or testing within), I think it's less neccesary.