Skip to content

Update documentation to recommend version pinning #343

Open
@ianfixes

Description

@ianfixes

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions