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

Update documentation to recommend version pinning #343

Open
ianfixes opened this issue Jan 17, 2023 · 0 comments
Open

Update documentation to recommend version pinning #343

ianfixes opened this issue Jan 17, 2023 · 0 comments
Labels
docs Documentation enhancement New feature or request

Comments

@ianfixes
Copy link
Collaborator

ianfixes commented Jan 17, 2023

Issue Summary

This project follows the SemVer standard of versioning its releases, to help users make informed choices about updating their dependencies on the arduino_ci gem.

However, all the documentation provides examples that explicitly install the latest version. This has led to new changes actively breaking other users' builds.

We should fix the documentation to show best practices: version pinning by default.

Possibly, also write a script to ease the update process (automatically bump the version, commit it, push a feature branch, and open a PR) for users who have a lot of repositories -- @RobTillaart for example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant