saltstack / saltstack/salt

Proposal: Introduce a "line" state that replaces `file.line`

Open
#33,751 16 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

bug severity-high
Dominant language
Python
Stars
15.7k
Forks
5.6k
Avg merge
2d 44m
Merged PRs (30d)
80

Description

The file.line state (and its equivalent file.line module) is really hard to understand and use. While better documentation would help, I think both the module function and the state function simply wants to do too much. Therefor, it will be really hard to document and really hard for users to properly be able to use.

Proposal:

  • Deprecate file.line state/module.
  • Introduce a line state/module with more granular methods.
  • This issue will be a collection of use-cases that the module and state should cover.

What do you think of this? If I get a couple of thumbs up I can get started adding use cases.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing file.line state and module, then read issue #27295 and the discussion here for the reported use cases. The proposal is not complete until the use cases and the scope of the replacement line state/module are agreed, including the deprecation plan.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
devops, infrastructure
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.