circleci-queue icon indicating copy to clipboard operation
circleci-queue copied to clipboard

[3.0.0] Document breaking changes

Open davidjb opened this issue 1 year ago • 1 comments

Orb version

3.0.0+

What happened

Updating to 3.1.1, there are number of parameter changes that break previous usage and require delving into the code (https://github.com/eddiewebb/circleci-queue/commit/4c639c89a6c883d00a16aec2a334bdce1ffff0f9) to determine what they are.

Expected behavior

Update the changelog or other documentation with the specifics of the breaking change - e.g. my-pipeline is now required and various parameters have changed their names (e.g. time is now max-wait-time_. Even if the changelog mentioned these changes in general linked someone off to the specific commit, then that would make updating easier.

davidjb avatar Feb 29 '24 03:02 davidjb

+1

The user guide also needs updating, a single argument is no longer correct. Help determining how to find the pipeline number would also be appreciated.

Screenshot 2024-03-05 at 11 40 13 AM

titanium-cranium avatar Mar 05 '24 00:03 titanium-cranium

I was slightly puzzled as to this being closed. After digging around a bit, I discovered that this orb is deprecated and CircleCI now has native support for equivalent behaviour. Details are in the published description at https://circleci.com/developer/orbs/orb/eddiewebb/queue.

I imagine that’s the gist of it, @eddiewebb?

The replacement serial-group feature is detailed at https://circleci.com/docs/configuration-reference/#serial-group and CircleCI official announcement at https://circleci.com/changelog/avoid-commit-conflicts-in-your-pipelines-with-serial-jobs/.

davidjb avatar Mar 11 '25 21:03 davidjb

Yes! Sorry for the confusion, that's exactly the reason for closing this and all open items. I left the one open issue sharing details of the deprecation.

On Tue, Mar 11, 2025, 5:12 PM David Beitey @.***> wrote:

I was slightly puzzled as to this being closed. After digging around a bit, I discovered that this orb is deprecated and CircleCI now has native support for equivalent behaviour. Details are in the published description at https://circleci.com/developer/orbs/orb/eddiewebb/queue.

I imagine that’s the gist of it, @eddiewebb https://github.com/eddiewebb ?

— Reply to this email directly, view it on GitHub https://github.com/eddiewebb/circleci-queue/issues/120#issuecomment-2715718878, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABIEWSXIN6WCKKYPBK5ZI332T5GUFAVCNFSM6AAAAABYZQUMTKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDOMJVG4YTQOBXHA . You are receiving this because you were mentioned.Message ID: @.***> [image: davidjb]davidjb left a comment (eddiewebb/circleci-queue#120) https://github.com/eddiewebb/circleci-queue/issues/120#issuecomment-2715718878

I was slightly puzzled as to this being closed. After digging around a bit, I discovered that this orb is deprecated and CircleCI now has native support for equivalent behaviour. Details are in the published description at https://circleci.com/developer/orbs/orb/eddiewebb/queue.

I imagine that’s the gist of it, @eddiewebb https://github.com/eddiewebb ?

— Reply to this email directly, view it on GitHub https://github.com/eddiewebb/circleci-queue/issues/120#issuecomment-2715718878, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABIEWSXIN6WCKKYPBK5ZI332T5GUFAVCNFSM6AAAAABYZQUMTKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDOMJVG4YTQOBXHA . You are receiving this because you were mentioned.Message ID: @.***>

eddiewebb avatar Mar 12 '25 01:03 eddiewebb