fix: monitoring artifact sizes with GoReleaser#25
Merged
Conversation
The `report_sizes` section in GoReleaser allows you to generate a **detailed size report** for all release artifacts. This feature is invaluable for tracking artifact growth, maintaining size limits, and troubleshooting issues. --- ### Example Configuration ```yaml report_sizes: true ``` Enabling this setting generates a report that lists the sizes of all artifacts produced during the release process. --- ### Key Benefits 1. **Tracking Binary Growth** Gain insights into how the sizes of your artifacts evolve over time. This is particularly useful for identifying trends in binary growth as your project scales. 2. **Maintaining Size Limits** Monitor artifact sizes to ensure they remain within acceptable thresholds, which is especially important for projects with strict size constraints. 3. **Debugging Issues** Quickly identify unexpected increases in artifact size that could indicate bugs, inefficient code, or unintentional inclusions. --- # Quoting the GoReleaser documentation: - https://goreleaser.com/customization/reportsizes/ ## Report Sizes You might want to enable this if you want to keep an eye on your binary/package sizes. It'll report the size of each artifact of the following types to the build output, as well as on `dist/artifacts.json`: - `Binary` - `UniversalBinary` - `UploadableArchive` - `PublishableSnapcraft` - `LinuxPackage` - `CArchive` - `CShared` - `Header` Here's the available configuration options: ```yaml title=".goreleaser.yaml" # Whether to enable the size reporting or not. report_sizes: true ```
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
report_sizessection in GoReleaser allows you to generate a detailed size report for all release artifacts. This feature is invaluable for tracking artifact growth, maintaining size limits, and troubleshooting issues.Example Configuration
Enabling this setting generates a report that lists the sizes of all artifacts produced during the release process.
Key Benefits
Tracking Binary Growth
Gain insights into how the sizes of your artifacts evolve over time. This is particularly useful for identifying trends in binary growth as your project scales.
Maintaining Size Limits
Monitor artifact sizes to ensure they remain within acceptable thresholds, which is especially important for projects with strict size constraints.
Debugging Issues
Quickly identify unexpected increases in artifact size that could indicate bugs, inefficient code, or unintentional inclusions.
Quoting the GoReleaser documentation:
Report Sizes
You might want to enable this if you want to keep an eye on your binary/package
sizes.
It'll report the size of each artifact of the following types to the build
output, as well as on
dist/artifacts.json:BinaryUniversalBinaryUploadableArchivePublishableSnapcraftLinuxPackageCArchiveCSharedHeaderHere's the available configuration options: