Expose Settings for Build Report Inspector to allow custom date formatting

Open
#16 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
csharp, unity
Domain
game-dev, tooling

Research direction

Start by locating the BuildReportInspector code containing the shown assetPath construction and inspect how build reports are written in the Unity editor. Clarify whether the intended completion is a Settings UI for the date format or only a fixed ISO 8601 format; done means generated .buildreport filenames sort chronologically and the chosen behavior is covered by an appropriate test or verification.

Written by the indexing model from the issue text.

Description

BuildReportInspector hard-codes build report output path but more importantly it hard-codes the filename date formatting in a way I find unacceptable: using Unity Build Reporter as a Package Manager package my only option currently is manually renaming every file after Build Report Inspector creates it.

This is the hard-coding in question

var assetPath = buildReportDir + "/Build_" + date.ToString("yyyy-dd-MMM-HH-mm-ss") + ".buildreport";

Resulting in a filename like "Build-2020-15-kesä-15-59-06" on my computer, which is neither what I prefer but more importantly does not sort chronologically for quick and legible browsing and organizing (Project Assets view is sorted alphabetically and hard-coded format does not sort the entries in any chronological order which is relevant when making comparisons of the builds as chronological series).

I'd much prefer if you expose a Settings UI for customizing the defalt filename date formatting when outputting .buildreport files, but failing that you could just hardcode it in ISO 8601 "YYYY-MM-DD-hh-mm-ss" as described in https://en.wikipedia.org/wiki/ISO_8601

Dominant language
C#
Stars
424
Forks
61
No merged PRs in 30d

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.

More from Unity-Technologies/BuildReportInspector

All issues in Unity-Technologies/BuildReportInspector

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.