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.
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.
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 nowmax-wait-time
_. Even if the changelog mentioned these changes in general linked someone off to the specific commit, then that would make updating easier.