From 4908c357b1461b70cf192a424512dc8588e14a38 Mon Sep 17 00:00:00 2001 From: Lucas Kacher Date: Tue, 27 Jun 2023 14:53:43 -0700 Subject: [PATCH] Documentation: formatting (#11) * documentation: formatting * retest this please --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a96795b..f10888f 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,15 @@ [![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 +Forked from 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-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. ## Configuration Requirements -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) +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: ) --- @@ -26,6 +25,7 @@ In order to use this orb you will need to export a `CIRCLECI_API_TOKEN` secret a 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! ### How to Publish An Update + 1. Merge pull requests with desired changes to the main branch. - For the best experience, squash-and-merge and use [Conventional Commit Messages](https://conventionalcommits.org/). 2. Find the current version of the orb. @@ -33,7 +33,7 @@ We welcome [issues](https://github.com/promiseofcake/circleci-workflow-queue/iss 3. Create a [new Release](https://github.com/promiseofcake/circleci-workflow-queue/releases/new) on GitHub. - Click "Choose a tag" and _create_ a new [semantically versioned](http://semver.org/) tag. (ex: v1.0.0) - We will have an opportunity to change this before we publish if needed after the next step. -4. Click _"+ Auto-generate release notes"_. +4. Click _"+ Auto-generate release notes"_. - This will create a summary of all of the merged pull requests since the previous release. - 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. 5. Now ensure the version tag selected is semantically accurate based on the changes included.