Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[3.0.0] Document breaking changes #120

Open
davidjb opened this issue Feb 29, 2024 · 1 comment
Open

[3.0.0] Document breaking changes #120

davidjb opened this issue Feb 29, 2024 · 1 comment

Comments

@davidjb
Copy link
Contributor

davidjb commented Feb 29, 2024

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 (4c639c8) 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.

@titanium-cranium
Copy link

titanium-cranium commented Mar 5, 2024

+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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants