microsoft / microsoft/winget-cli

Group logs into folders

Open
#4,796 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue-Feature
Dominant language
C++
Stars
26.4k
Forks
1.8k
Avg merge
1d 11h
Merged PRs (30d)
15

Description

Description of the new feature / enhancement

When running WinGet, sometimes there are multiple log files generated -

  • The WinGet CLI Log
  • The COM Log
  • The Installer Log

For a new user, when these logs are requested it can be difficult to know exactly which log to grab. Therefore, it would be best if they were grouped together into folders and/or zipped up afterwards to make transferring the log files and attaching them to issues easier

Proposed technical implementation details
  • Refactor the logging interface to create a new folder each time it creates a log - this folder should be the timestamp for the log files
  • Place all WinGet logs for the run inside the new folder
  • Update the default path for package installer logging to point to the new folder
  • Remove the timestamp from the name of files created within the folder (to help avoid file path character limit issues)

Nice to have:

  • Zip the files up each time and remove the un-compressed folder
  • A user setting controlling whether or not to Zip the logs afterwards (default to zipping the logs)

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 locating the logging interface and the code that creates the WinGet, COM, and installer logs. Trace how the package installer log path is chosen, then verify that one timestamped folder contains all logs with timestamps removed from filenames; zipping and the user setting are listed as nice-to-have work.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.