Repository navigation
Publish only a whitelist of files in the gem - #5
Merged
Merged
Conversation
`git ls-files` with no filter published everything tracked, so the gem is 1.3 MB of which ~12 KB is the actual library. The bulk is two README demo gifs: screen/example_aa_filters_ordering.gif 722 KB screen/example_aa_filters_visibility.gif 656 KB 98% of every download, for images referenced from README.md as repo-relative paths — GitHub renders them out of the repo and nothing ever reads them from the package. The test/spec/features part of the filter is prophylactic: master has no spec/ today, but without a filter the first suite added ships to consumers automatically. Drops `s.test_files` while here: RubyGems deprecated it, and it pointed at paths that do not exist on master. Packaged: 11 files / 1.3 MB -> 9 files / 12 KB.
Fivell
force-pushed
the
chore/exclude-specs-from-gem
branch
from
September 30, 2026 10:51
39e6cfc to
48911bd
Compare
Fivell
changed the title
The reject list only removes directories someone remembered to name. That is how spec/, .github/, screen/ and img/ got published in the first place — each needed a new pattern, and none was added until an audit went looking. A whitelist inverts the default: a new directory in the repo does not reach consumers until it is listed. Same shape the sibling gems activeadmin-oidc and credit_card_validations already use. Drops the remaining dev-only files the reject form kept: active_admin_filters_visibility.gemspec Gemfile package.json Rakefile Packaged: 9 -> 5 files. The runtime payload — everything under lib/, app/, vendor/, config/ and exe/ — is byte-identical to before, verified by diffing the built .gem both ways.
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The whitelist omits files that the PR says will remain in the package.
Review effort: Balanced
Findings: 1
Open (1)
What changed in this PR
This PR narrows the gem’s packaged files to keep README demo GIFs out of downloads.
Changes:
- Replaces the
git ls-filespackage list with a whitelist. - Removes the deprecated
s.test_filessetting.
| File | Description |
|---|---|
| active_admin_filters_visibility.gemspec | Changes the packaged-file list and removes test-file metadata. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
`Dir[...]` globs the working tree, so any untracked or generated file under lib/, app/ or vendor/ would be published in a release — the build artifact depended on the releaser's local checkout. The reject form it replaced was tracked-only; this restores that property while keeping the whitelist. `git ls-files -- <paths>` also returns files only, where `Dir["**/*"]` returns directory entries too, so `files` no longer carries entries RubyGems just ignores. Built .gem is byte-for-byte the same file list as the Dir[] version.
Fivell
changed the title
A whitelist fails quietly: `git ls-files -- config` against a tree with no config/ exits 0 and prints nothing, so the day someone adds `config/initializers/foo.rb` the gem installs, boots, and the initializer never runs. Nothing in `gem build` warns. That is not hypothetical for this family of gems — active_admin_datetimepicker's Ransack predicates live in exactly such an initializer, and its filters return no results without them. So list every root Rails::Engine loads from (lib app vendor config exe bin) in all of them, present or not, instead of only the ones that happen to exist today. No package changes: the built .gem is identical in every gem.
The whitelist names every root a Rails::Engine loads from so the list does
not silently lose a directory the day one is added. db was missing:
railties-8.1.4 lib/rails/engine/configuration.rb registers
paths.add "db"
paths.add "db/migrate"
paths.add "db/seeds.rb"
as engine roots, and `rake <engine>:install:migrations` copies out of
db/migrate — so a migration added later would have installed with the gem
and been invisible. public/ is deliberately not added: it is registered by
Rails::Application, not Rails::Engine.
No change to the current artifact. `gem build` before and after produces
the same 5 files:
LICENSE
README.md
app/assets/javascripts/active_admin_filters_visibility.js
lib/active_admin_filters_visibility.rb
lib/active_admin_filters_visibility/version.rb
`git ls-files -- db` against a tree with no db/ exits 0 and prints nothing.
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.
What
filesis now an explicit whitelist, instead of publishing everything tracked minus whatever someone remembered to exclude.A reject list only removes what someone named. That is how 2 README images ended up in the published gem — each needed its own pattern, and none was added until an audit went looking. A whitelist inverts the default: a new directory does not reach consumers until it is listed.
Every root
Rails::Engineloads from is listed, present in this repo or not —app,lib,config,db,vendorperrails/engine/configuration.rb. A whitelist fails quietly —git ls-files -- configagainst a tree with noconfig/exits 0 and prints nothing — so the day someone addsconfig/initializers/foo.rbthe gem would install, boot, and never run it. Naming the roots up front costs nothing (git ls-fileson a missing path is a no-op) and removes that trapdoor.Selected through
git ls-filesrather thanDir[...]so the artifact stays tracked-only — an untracked or generated file underlib/cannot leak into a release — and sofilescarries no directory entries.Verified
All 5 files that remain. Nothing is added, and the entire runtime payload — the 3 files under
app/,lib/— is unchanged:All 6 files that leave the package:
The 4 root files leave on purpose — nothing under
lib/orapp/reads any of them.GemfileandRakefiledrive the development bundle andbundler/gem_tasksfrom a git checkout.package.jsonis the npm manifest; it publishessrc/**/*, whichprepublishOnlygenerates fromapp/assets/javascripts/, also in a checkout. And the full spec is already in the package's ownmetadata.gz, so the.gemspecfile insidedata.tar.gzwas a duplicate of it.