Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Possibility to omit file breakdown #102

Merged
merged 6 commits into from
Dec 1, 2022

Conversation

yamal-coding
Copy link
Contributor

What has changed

Possibility to omit file breakdown from the report. That includes, list of files for each component and dynamic feature, file type and resource type distribution charts, and all ownership info regarding files.

This is an optional feature that can be enabled by activating a flag in the Ruler Gradle config:

ruler {
    omitFileBreakdown.set(true) // false by default
}

The only change in the JSON format of the report is that files field inside each component or dynamic feature is now nullable.

Why was it changed

A first and similar attempt to omit file information was proposed in #101, where only the list of files for each file container was omitted. However, that implied several changes on the format of the report and more complexity. After having received some feedback from @simonschiller , we have agreed that it could be a bit confusing to keep file charts and ownership file info if there isn’t a list of files that can back up that data.

On the other hand, my initial motivation behind this change was to provide a way to reduce the report size. We can’t completely get rid of the list of files because that is something necessary if we want more detailed reports. But we should have the opportunity to generate lighter reports in case that extra information is not required at some point.

Related issues

#101
#96

Copy link
Collaborator

@simonschiller simonschiller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks pretty good, only a few comments

Copy link
Collaborator

@simonschiller simonschiller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks very good now, only 1 small comment. Good to merge from my side if the team is happy with it 😄

@botronic
Copy link
Collaborator

Looks great @yamal-coding, when you apply the last suggestion from @simonschiller we're happy to merge it 😄

@botronic botronic merged commit ea838ac into spotify:main Dec 1, 2022
@yamal-coding yamal-coding deleted the omit-file-breakdown branch December 1, 2022 08:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants