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

Can rubocop gem be excluded from distribution? #187

Open
danielvaughan opened this issue Oct 7, 2020 · 4 comments
Open

Can rubocop gem be excluded from distribution? #187

danielvaughan opened this issue Oct 7, 2020 · 4 comments

Comments

@danielvaughan
Copy link

Thanks for submitting an issue to cloud_controller_ng. We are always trying to improve! To help us, please fill out the following template.

Issue

Please consider not distributing the rubocop-0.79.0.gem.

Context

RuboCop from my understanding is a Ruby linter used in this project in testing. Unfortunately, the rubocop gem file gets packaged up and makes it through to the capi-release release and so into Cloud Foundry distributions. The problem with this is the "Robocop like" logo gets included in gem (rubocop-0.79.0.gem/assets/logo.png). The logo itself has a non-commercial licence this may cause problems to upstream projects.

As from what I see rubocop is only used for testing and is likely, not necessary in the Cloud Foundry release can it be excluded by only being used in the test context to get around this potential problem, please?

Steps to Reproduce

The problem file is in:

var/vcap/packages/cloud_controller_ng/cloud_controller_ng/vendor/cache/rubocop-0.79.0.gem/assets/logo.png

Expected result

Please exclude rubocop-0.79.0.gem when packaging for release

Current result

Rubocop gem is included at:

var/vcap/packages/cloud_controller_ng/cloud_controller_ng/vendor/cache/rubocop-0.79.0.gem

Possible Fix

[not obligatory, but suggest fixes or reasons for the bug]

name of issue screenshot

[if relevant, include a screenshot]

@cf-gitbot
Copy link

We have created an issue in Pivotal Tracker to manage this:

https://www.pivotaltracker.com/story/show/175162482

The labels on this github issue will be updated when the story is started.

@danielvaughan danielvaughan changed the title Can rubocop be excluded from distribution? Can rubocop gem be excluded from distribution? Oct 7, 2020
@Gerg
Copy link
Member

Gerg commented Oct 29, 2020

It looks like we are attempting to omit test dependencies from capi-release, but I can confirm that rubocop and other test dependencies are included in the releases.

Related issue: rubygems/bundler#2595

@weymanf
Copy link
Contributor

weymanf commented Feb 5, 2021

Looks like we can't avoid using bundle package in our pre-packaging step which will include all our gems in the vendored path.

However, we can remove the entire vendor path once we're finished doing our bundle install during our packaging step. Once we finish bosh_bundle_local it will only include production gems in the Gem path for bosh making it safe to delete the vendor folder.

@Gerg Gerg transferred this issue from cloudfoundry/cloud_controller_ng Feb 17, 2021
@cf-gitbot
Copy link

We have created an issue in Pivotal Tracker to manage this:

https://www.pivotaltracker.com/story/show/176985343

The labels on this github issue will be updated when the story is started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants