search

hashicorp / terraform-config-inspect

A helper library for shallow inspection of Terraform configurations
Mozilla Public License 2.0
376 stars 76 forks source link

Can I embed and modify this project within segmentio/terraform-docs #42

Closed khos2ow closed 4 years ago

khos2ow commented 4 years ago

We are currently trying to fix segmentio/terraform-docs#176 which internally would have depended on #24 but since terraform-config-inspect is considered to be feature-complete and it appears #24 is stalled and will not get merged, we've decided to move github.com/hashicorp/terraform-config-inspect as an internal package (github.com/segmentio/terraform-docs/internal/tfconfig) rather than it being an external vendor dependency and apply the changes in #24 directly in there (the change is done in https://github.com/segmentio/terraform-docs/pull/221).

I want to double check that we would be able to do this in-project fork and modification considering the license terraform-config-inspect is being released under. I've read the MPL-2.0 LICENSE and I believe we'd be able to do that but I want to be absolutely sure that this would be ok. I'd really appreciate it if you can advise on the matter.

khos2ow commented 4 years ago

@radeksimko @mildwonkey ping.

paultyng commented 4 years ago

@khos2ow yes you can use a modified fork of the code and distribute it with your own work, as long as you meet a few requirements (most notably including the LICENSE/copyright info). See some of the FAQs in more plain language here:

https://www.mozilla.org/en-US/MPL/2.0/FAQ/#distribute-modified-source

You can consider this issue you informing HashiCorp.

khos2ow commented 4 years ago

@paultyng that's great, thank you so much for the explanation.

khos2ow commented 4 years ago

@paultyng we went ahead with your suggestion and this is the in-repo fork of the terraform-config-inspect. I've included original license file in the folder too (here). Would you think this is enough or do I need to explicitly mention it somewhere else as well, e.g. our own README or LICENSE?

If everything looked good to you feel free to close this issue, otherwise please let me know.

paultyng commented 4 years ago

👍 Looks fine for me as is, but may be helpful to just add a quick pointer to the source somewhere in the README or something.