You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 part of a release yet, hence we need to guess a version number (3.2.0 here). user may get an error when trying to copy/paste and execute the example as the version do not exist yet.
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.
documentationImprovements or additions to documentation
1 participant
Converted from issue
This discussion was converted from issue #74 on January 18, 2022 23:58.
Heading
Bold
Italic
Quote
Code
Link
Numbered list
Unordered list
Task list
Attach files
Mention
Reference
Menu
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
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 part of a release yet, hence we need to guess a version number (3.2.0 here). user may get an error when trying to copy/paste and execute the example as the version do not exist yet.
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:
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)
Beta Was this translation helpful? Give feedback.
All reactions