Major: Orb Tools Version 12

[KyleTryon]

Orb Tools 12

⭐ Dynamic Orb Injection Without Publication

The major goal of this PR is to decrease friction in orb contributions. Currently, in order to contribute to an orb, you must have access to a secured Restricted Context in CircleCI which contains a publishing token, so that a development version of the orb may be tested in the following dynamic workflow. This means, when a contributor opens a PR, they must wait for a maintainer to re-push the code for the proper permissions. This slows down the dev cycle a lot.

With this change, rather than publishing a new development version of the orb, we modify the dynamic config template to inject the orb source as an "internal" orb within the continue job. This has the same net-effect for testing your orbs but not longer requires access to secrets, eliminating blockers top the PR process.

Other Improvements

• Parameter Standardizations
  • Snake Case (to match CircleCI's native parameter styles)
  • Consistent Env Var Naming
• RC010 - Enforcing Snake_Case
  • The new RC check enforces snake_case for consistency
• Orb filename is now modifiable
  • Resolves Feature: Introduce orb filename parameter #194, Unable to publish and pack multiple orbs within single workflow. #195
• Improve RC check messages
  • Resolves "No description" error is slightly confusing to read #187
• The checkout step is now optional, allowing for custom pre-step logic
  • Resolved Jobs should support a post-checkout-steps parameter #191
• Images pinned by default to stable tags
  • Resolved Clarify the CircleCI Base Docker image - current or intentionally pinned for stability? #189
• Publish multiple custom development tags at a time
  • You may now supply a custom list of development tags to publish for a single orb
  • Resolved Allow to release a development version of an orb with a custom tag #197
• More to come

Blocked By

• Prepare update to https://github.com/CircleCI-Public/Orb-Template/tree/main
• Verify Major Version Change will not negatively impact the orb init CLI command
• Is any auto-migration assistance needed? Investigate further the difficulty in upgrading
• Prepare any changes needed to the documentation

[EricRibeiro]

Thank you!

[wyardley]

Was it intentional to remove resource_class (e.g. from the publish step)?

[KyleTryon]

Hey @wyardley Yes! We changed away from statically defined images, where we were required to pass through parameters such as resource_class, simply to a parameterized executor. This gives a lot more flexibility outside of just resource class, but also any parameter that might exist for any executor you choose.

You should now be able to do something like looks like this:

orbs:
  orb-tools: circleci/orbtools@12
executors:
  my-exec:
    docker:
      - image: cimg/base:stable
    resource_class: small

workflows:
  example:
    jobs:
      - orb-tools/pack:
          executor: my-exec

Now the executor can come from anywhere, such as an orb, or be defined locally. When defined, or redefined locally, we can pass any parameters we want into the definition of the executor.

[wyardley]

Now the executor can come from anywhere, such as an orb, or be defined locally

Probably should have been called out in the migration guide and / or breaking changes for 12.x?

IIRC, this used to not be possible? Can you give an example of using an upstream orb, but overriding a parameter like resource_class?

For me, the following gives an error

orbs:
  orb-tools: circleci/orb-tools@12.0.0
executors:
  orb-tools:
    name: orb-tools/default
    resource_class: small
workflows:
  test-pack:
    jobs:
      - orb-tools/lint:
          executor: orb-tools

{2. [#/executors/orb-tools] extraneous key [name] is not permitted}

IIRC, this used to be impossible, but maybe something has changed and I just have the wrong syntax?

(and, if it's not possible anymore, what can

orb-tools-orb/src/executors/default.yml

Lines 11 to 15 in d82dc25

	resource_class:
	description: Configure the executor resource class
	type: enum
	enum: ["small", "medium", "medium+", "large", "xlarge", "2xlarge", "2xlarge+"]
	default: "medium"

be used for now?)