Community Contributions

[kpapagno]

Hi -

I am looking for some additional guidelines on community contributions. I for example, am looking for additional functionality on the aws plugin (sepecifically the just added for configservice); adding tables for:

• conformance-packs
• config-rules
• organization-config-rules,
• get-compliance-details-by-config-rule
• get-compliance-details-by-resource
• get-compliance-summary-by-config-rule
• get-compliance-summary-by-resource-type
• get-conformance-pack-compliance-details
• get-conformance-pack-compliance-summary

Knowing that these are not in the mainstream for most AWS users, I thought I'd give it a shot myself, though I've never coded in Go, the mods for adding a new table didn't seem too foreign to me. I saw the developer guidelines, and the steampipe contributing file, which were great for field name assistance, etc. But I didn't see anything on how to locally test the updated plugin, etc.

What I did so far, was:

1. Create new table_aws_config_conformance_pack.go file
2. Added the new table to plugin.go TableMap
3. Successfully compiled my code (eventually) with
   go build -o ~/.steampipe/plugins/hub.steampipe.io/plugins/turbot/aws@latest/steampipe-plugin-aws.plugin *.go
4. Realized that essentially overwrote the plugin locally
5. Started steampipe query interactive
6. started typing command select * from aws.aws_config and realized by autocompletion my new aws.aws_config_conformance_pack was not there.
7. I noticed that there are hashes and versions stored in steampipe_registry_plugin_version, so maybe the new local version was not honored, etc.

So, what is the proper way to contribute to an existing plug-in, test locally, and then submit a pull request?

Thanks!

Ken

[e-gineer]

Hey @kpapagno ... that's awesome, thanks for stepping up to help! 🚀

So glad you managed to get the development cycle working. We have a draft of those instructions (very close to what you wrote) internally and are looking to get it updated in the docs - so definitely we'll be able to improve those.

As you suggest, please just open a pull request on the steampipe-plugin-aws repo and we'll be very happy to help out, discuss and review with you!

Any questions, please don't hesitate to ask - we think table building is a lot of fun and are keen to make it really smooth & easy.

[johnsmyth]

@kpapagno If you push some code i would be happy to take a look, but generally after you add your table .go file, you also need to add the table to the plugin def in the plugin.go, then build (you can jsut run 'make'), make sure you have a connection file (i assume you already do given that you are using aws), then restart steampipe.