feat: qol (#4)

promiseofcake · Dec 8, 2022 · 2fed33a · 2fed33a
1 parent f7a0557
commit 2fed33a
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 6 deletions.
diff --git a/.circleci/test-deploy.yml b/.circleci/test-deploy.yml
@@ -11,11 +11,12 @@ workflows:
   test-deploy:
     jobs:
       # Make sure to include "filters: *filters" in every test job you want to run as part of your deployment.
+      - orb-tools/pack:
+          filters: *filters
       - workflow-queue/queue:
           filters: *filters
           context: orb-publishing
-      - orb-tools/pack:
-          filters: *filters
+          requires: [orb-tools/pack]
       - orb-tools/publish:
           orb-name: promiseofcake/workflow-queue
           vcs-type: << pipeline.project.type >>

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 <organization>
+Copyright (c) 2022 Lucas Kacher
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1,9 +1,18 @@
 # circleci-workflow-queue
 
-
 [![CircleCI Build Status](https://circleci.com/gh/promiseofcake/circleci-workflow-queue.svg?style=shield "CircleCI Build Status")](https://circleci.com/gh/promiseofcake/circleci-workflow-queue) [![CircleCI Orb Version](https://badges.circleci.com/orbs/promiseofcake/workflow-queue.svg)](https://circleci.com/orbs/registry/orb/promiseofcake/workflow-queue) [![GitHub License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/promiseofcake/circleci-workflow-queue/master/LICENSE) [![CircleCI Community](https://img.shields.io/badge/community-CircleCI%20Discuss-343434.svg)](https://discuss.circleci.com/c/ecosystem/orbs)
 
 
+## Introduction
+
+Forked from https://github.com/eddiewebb/circleci-queue and updated to reduce the use-cases, and migrate to the CircleCI V2 API
+
+The purpose of this Orb is to add a concept of a queue to specific branch workflow tasks in CircleCi. The main use-cases is to isolate a set of changes to ensure that one set of a thing is running at one time. Think of smoke-tests against a nonproduction environment.
+
+## Configuration Requirements
+
+In order to use this orb you will need to export a CIRCLECI_USER_AUTH secret added to a context of your choosing. The token is generated and stored as a Basic Auth of a Circle Token (see: https://support.circleci.com/hc/en-us/articles/360052405651-Utilizing-Basic-Authorization-in-CircleCI-API-Calls)
+
 ---
 
 ## Resources

diff --git a/src/commands/queue.yml → src/commands/block_execution.yml b/src/commands/queue.yml → src/commands/block_execution.yml
@@ -28,7 +28,7 @@ parameters:
 
 steps:
   - run:
-      name: Queue Until Front of Line
+      name: Block execution until workflow is at the front of the line
       environment:
         CONFIG_DEBUG_ENABLED: "<< parameters.debug >>"
         CONFIG_TIME: "<< parameters.time >>"

diff --git a/src/jobs/queue.yml b/src/jobs/queue.yml
@@ -31,7 +31,7 @@ parameters:
       Default is one confirmation, increase if you see issues.
 
 steps:
-  - queue:
+  - block_execution:
       debug: << parameters.debug >>
       time: <<parameters.time>>
       dont-quit: <<parameters.dont-quit>>