tofuutils/tenv

Add Details About tenv Lockfiles to the documentation

Open

#302 opened on Dec 21, 2024

View on GitHub
 (0 comments) (2 reactions) (1 assignee)Go (75 forks)auto 404
documentationenhancementgood first issuehacktoberfest

Repository metrics

Stars
 (1,402 stars)
PR merge metrics
 (PR metrics pending)

Description

Describe the solution you'd like Enhance the documentation by including information about how tenv handles lockfiles, particularly when multiple instances are run in parallel. Currently, it is unclear whether tenv fails outright if the lock is already taken or if it waits for the lock to be released. Providing clarity on this behavior will help users understand the expected behavior in such scenarios and avoid potential confusion or misconfigurations.

Additional context Link to slack discussion: https://opentofucommunity.slack.com/archives/C05R0FD0VRU/p1734253608366379

Contributor guide

Research direction
Review the existing documentation on tenv lockfiles, inspect the code to understand lockfile behavior, and update the docs to clarify whether tenv waits or fails when lock is taken.
Tech stack
go
Domain
clidocumentationdevops
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90