Skip to content

Should we pin module versions in examples? #74

@kral2

Description

@kral2

The more I think about pinning version in modules examples or not, the more I tend to say no. Here is the rational behind my current view on that matter.

The problem is that the example's files are not released yet, hence version 3.2.0 will not be able to support this example: user will get an error when trying to copy/paste and execute the example.

In addition, we would always need to come back to example files and keep module version current.

Letting modules in examples without versions on purpose seems to be a better tradeoff:

  • less maintenance,
  • released versions on the registry (that is, with a tag) always works.
  • bleeding edge users can always source the module using the git pattern url and use repo's HEAD (great for testing by the way).

But let's settle this later and not block the PR from being merged into main. If we choose to not pin module versions in examples, we will to search and update every occurrences of it before cutting the next release tag.

Originally posted by @kral2 in #72 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions