IBM-Cloud / IBM-Cloud/ibm-cloud-sdk-ruby

Minimize gems sizes

Open
#97 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Ruby
Stars
5
Forks
16
PR merge metrics
No merged PRs in 30d

Description

With the new autogenerated gems, I notice that they include everything in the packages. I think we should remove docs and specs. It also uses find *, which is bad as it pulls in .gitignored files as well as other ancillary things (like previous gem packages and other cruft).

Additionally, the README is very large - I wonder if there's an openapi setting to remove the docs from the README (especially since a whole separate docs dir is created). If not, maybe we can put in an upstream change for that.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by locating the autogenerated gem packaging entry point and the use of find *; inspect how the generated README and separate docs directory are produced. Done means packages omit docs, specs, ignored files, previous gem packages and other cruft, with README documentation reduced if an OpenAPI setting supports it.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, ruby
Domain
build-system, release
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.