Skip to content

Commit 78e05c2

Browse files
committed
doc: update readme
1 parent 661a36f commit 78e05c2

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# circleci-workflow-queue
22

3-
43
[![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)
54

65

@@ -10,6 +9,10 @@ Forked from https://github.com/eddiewebb/circleci-queue and updated to reduce th
109

1110
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.
1211

12+
## Configuration Requirements
13+
14+
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)
15+
1316
---
1417

1518
## Resources

0 commit comments

Comments
 (0)