Skip to content

Commit 4908c35

Browse files
Documentation: formatting (#11)
* documentation: formatting * retest this please
1 parent e9c236d commit 4908c35

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,15 @@
22

33
[![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)
44

5-
65
## Introduction
76

8-
Forked from https://github.com/eddiewebb/circleci-queue and updated to reduce the use-cases, and migrate to the CircleCI V2 API
7+
Forked from <https://github.com/eddiewebb/circleci-queue> and updated to reduce the use-cases, and migrate to the CircleCI V2 API
98

109
The purpose of this Orb is to add a concept of a queue to specific branch workflow tasks in CircleCi. The main use-case 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 as a promotion gate.
1110

1211
## Configuration Requirements
1312

14-
In order to use this orb you will need to export a `CIRCLECI_API_TOKEN` secret added to a context of your choosing. It will authentcation against the CircleCI API to check on workflow status. (see: https://circleci.com/docs/api/v2/index.html#section/Authentication)
13+
In order to use this orb you will need to export a `CIRCLECI_API_TOKEN` secret added to a context of your choosing. It will authentcation against the CircleCI API to check on workflow status. (see: <https://circleci.com/docs/api/v2/index.html#section/Authentication>)
1514

1615
---
1716

@@ -26,14 +25,15 @@ In order to use this orb you will need to export a `CIRCLECI_API_TOKEN` secret a
2625
We welcome [issues](https://github.com/promiseofcake/circleci-workflow-queue/issues) to and [pull requests](https://github.com/promiseofcake/circleci-workflow-queue/pulls) against this repository!
2726

2827
### How to Publish An Update
28+
2929
1. Merge pull requests with desired changes to the main branch.
3030
- For the best experience, squash-and-merge and use [Conventional Commit Messages](https://conventionalcommits.org/).
3131
2. Find the current version of the orb.
3232
- You can run `circleci orb info promiseofcake/workflow-queue | grep "Latest"` to see the current version.
3333
3. Create a [new Release](https://github.com/promiseofcake/circleci-workflow-queue/releases/new) on GitHub.
3434
- Click "Choose a tag" and _create_ a new [semantically versioned](http://semver.org/) tag. (ex: v1.0.0)
3535
- We will have an opportunity to change this before we publish if needed after the next step.
36-
4. Click _"+ Auto-generate release notes"_.
36+
4. Click _"+ Auto-generate release notes"_.
3737
- This will create a summary of all of the merged pull requests since the previous release.
3838
- If you have used _[Conventional Commit Messages](https://conventionalcommits.org/)_ it will be easy to determine what types of changes were made, allowing you to ensure the correct version tag is being published.
3939
5. Now ensure the version tag selected is semantically accurate based on the changes included.

0 commit comments

Comments
 (0)