Reduce gem size #633
Open
Reduce gem size #633
Conversation
This file contains 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
This reduces the Auth0 gem size by changing `files` in the gemspec. Currently, the gem contains many unnecessary files for execution, such as tests or examples. Besides, since `test_files` in the gemspec is unsupported, we can remove it. See https://guides.rubygems.org/specification-reference/ To verify this change locally, run the command for each branch and compare each output: ```sh gem build ``` Here's a size diff in my local environment: ```sh-session $ du -h auth0-*.gem* 40K auth0-5.17.0.gem 216K auth0-5.17.0.gem.current ``` In addition, we can compare included files in the gem as well: ```shell bundle exec ruby -e 's = Gem.loaded_specs["auth0"]; puts s.files + s.executables' ``` For example: ```shell git switch master bundle exec ruby -e 's = Gem.loaded_specs["auth0"]; puts s.files + s.executables' > before git switch reduce-gem-size bundle exec ruby -e 's = Gem.loaded_specs["auth0"]; puts s.files + s.executables' > after diff -u before after ```
ybiquitous
commented
Nov 28, 2024
| s.files = `git ls-files`.split("\n") | ||
| s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n") | ||
| s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) } | ||
| s.files = `git ls-files -z -- LICENSE README.md lib`.split("\x0") |
There was a problem hiding this comment.
LICENSE README.md lib is a discussion point. Please let me know if you want to change.
There was a problem hiding this comment.
For example, including EXAMPLES.md may make sense:
Suggested change
| s.files = `git ls-files -z -- LICENSE README.md lib`.split("\x0") | |
| s.files = `git ls-files -z -- EXAMPLES.md LICENSE README.md lib`.split("\x0") |
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.
Changes
This reduces the Auth0 gem size by changing
filesin the gemspec.Currently, the gem contains many unnecessary files for execution, such as tests or examples.
Besides, since
test_filesin the gemspec is unsupported, we can remove it.See https://guides.rubygems.org/specification-reference/
To verify this change locally, run the command for each branch and compare each output:
Here's a size diff in my local environment:
In addition, we can compare included files in the gem as well:
For example:
Diff output
References
Testing
This change should be tested on each developer's local environment, instead of unit/integration tests, as I explained above.
Checklist