Closed gmemstr closed 3 years ago
Semver - minor for an API incompatible change?
For reference, here's the error one gets who still passes the argument
#!/bin/sh -eo pipefail
# Error calling workflow: 'ads_prod'
# Error calling job: 'store_homepage_ads_prod'
# Error calling command: 'aws-s3/sync'
# Unexpected argument(s): overwrite
It might be worth pointing out the upgrade path in the changelog. something along:
overwrite
. newer files will always be overwritten on the target by defaultarguments.delete
to maintain the behavior from the previous version@tobypinder Generally speaking, we change major semver when something is a major breakage or behaviour change. This is a relatively small change, so we opted for a minor - this allows users using 1.0.x
versions to ignore the change. We typically recommend versioning orbs in configurations to the nearest patch version, or minor if patch is determined to be too granular.
Thanks for your comment @gmemstr - this was a breaking change for anyone using this option. circle fails validating the configuration of the orb before even running the task
@masone Yup, understood - that's on me, and I apologize for the oversight. There are two options here - either we keep it the same, with no remediation, or we roll a new minor or patch version to revert this change, and push the change out again as a major change. If we opt for the second option, there may be some additional changes for the major version.
See #7