diff --git a/src/@orb.yml b/src/@orb.yml index 7379326..0ce432e 100755 --- a/src/@orb.yml +++ b/src/@orb.yml @@ -1,15 +1,10 @@ version: 2.1 description: > - Sample orb description -# What will your orb allow users to accomplish? -# Descriptions should be short, simple, and informative. - -# This information will be displayed in the orb registry and is not mandatory. + Allows jobs or entire workflows to be queued to ensure they run in serial. + This is ideal for deployments or other activities that must not run concurrently. + May optionaly consider branch-level isolation if unique branches should run concurrently. + This orb requires the project to have an CircleCI API key in order to query build states. display: - home_url: "https://www.example.com/docs" + home_url: "https://github.com/promiseofcake/circleci-workflow-queue" source_url: "https://github.com/promiseofcake/circleci-workflow-queue" - -# If your orb requires other orbs, you can import them like this. Otherwise remove the "orbs" stanza. -# orbs: -# hello: circleci/hello-build@0.0.5