Skip to content

Undocumented (but minor) breaking change in 0.14 #1109

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

Closed
obra opened this issue Dec 15, 2020 · 3 comments · Fixed by #1110
Closed

Undocumented (but minor) breaking change in 0.14 #1109

obra opened this issue Dec 15, 2020 · 3 comments · Fixed by #1110
Labels
topic: documentation Related to documentation for the project

Comments

@obra
Copy link
Contributor

obra commented Dec 15, 2020

As part of our build system, we were running 'config init' twice on jobs in CI. Arguably this is a bug.

0.14 changed arduino-cli's behavior in such cases.

0.13 silently either ignored the issue or just overwrote the old config.

0.14 fails with the error Config file already exists, use --overwrite to discard the existing one.

I don't think this is a -bad- choice, but it was a little surprising to see jobs start failing.

It'd be wonderful if stuff like this got into the docs, but I do understand if it's just too much of a burden during alpha.

@per1234 per1234 added topic: documentation Related to documentation for the project kind/bug labels Dec 15, 2020
@silvanocerza
Copy link
Contributor

Hi @obra, this is my fault I guess, I introduced this behaviour with #957 in September.

We didn't have the breaking changes policy back then, during the latest release process I tried to document breaking changes introduced before the policy but must have missed some I guess.

I'll edit the UPGRADING.md file accordingly.

Thanks for the report!

@silvanocerza
Copy link
Contributor

Upgrading documentation has been updated accordingly and just published. I also updated the release changelog.
https://arduino.github.io/arduino-cli/0.14/UPGRADING/#change-behaviour-of-config-file-flag-with-config-commands

Thanks again for the issue, wouldn't have noticed if not for you. :)

@obra
Copy link
Contributor Author

obra commented Dec 15, 2020

No worries :) Thanks!

@rsora rsora reopened this May 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants