chef / chef/effortless

[scaffolding-chef-inspec] Install action overwrites user default.toml

Open
#153 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Design Proposal
Dominant language
Shell
Stars
35
Forks
35
Avg merge
2d 7h
Merged PRs (30d)
8

Description

Problem Statement

There appears to be a bug in which if a user creates a default.toml and adds it to the /src directory when packaging Effortless Audit, upon installation of the package the default.toml is overwritten with a canned version.

This is the code that seems to be the offender here:

https://github.com/chef/effortless/blob/master/scaffolding-chef-inspec/lib/scaffolding.ps1#L172

I haven't verified in Linux if it's the same, but I have tested in Windows 2k12r2/2k16.

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 at scaffolding-chef-inspec/lib/scaffolding.ps1 around line 172 and reproduce installation with a user-provided default.toml in the packaged src directory. Verify the installation behavior on Windows and, if possible, Linux; done means the user's default.toml is not overwritten by the canned version.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell
Domain
tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.