Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
81 lines (56 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

81 lines (56 loc) · 2.34 KB
Raw

Contributing to kitchen-google

Thanks for your interest in improving kitchen-google. Bug reports, feature requests, and pull requests are all welcome.

Reporting issues

Report bugs and request features on the issue tracker. For bugs, please include:

  • the version of kitchen-google and Test Kitchen you are using
  • your kitchen.yml with credentials removed
  • the output of the failing command, ideally with -l debug

Development setup

Clone the repository and install the dependencies:

git clone https://github.com/test-kitchen/kitchen-google.git
cd kitchen-google
bundle install

Running the tests

Run the unit tests and the style check together:

bundle exec rake

Run them individually:

bundle exec rake test    # RSpec unit tests
bundle exec rake style   # Cookstyle / RuboCop

To run a single spec file:

bundle exec rspec spec/kitchen/driver/gce_spec.rb

Many style offenses can be corrected automatically:

bundle exec cookstyle -a

The unit tests mock the Google Compute Engine API, so they do not create real instances and do not require GCP credentials.

Manual testing against GCE

Changes that touch instance creation should also be exercised against a real project, since the unit tests cannot catch API-level regressions. Set up Application Default Credentials, point a kitchen.yml at a project you control, and run kitchen test. Remember that this creates billable resources — confirm the instances are gone with kitchen destroy and check the GCE console afterwards.

Submitting changes

  1. Fork the repository.
  2. Create a feature branch off main.
  3. Make your change, adding or updating tests to cover it.
  4. Make sure bundle exec rake passes.
  5. Push the branch to your fork and open a pull request.

Please keep pull requests focused on a single change — it makes review much faster. Update the documentation in README.md when you add or change a configuration option.

Release process

Releases are handled by the maintainers.

  1. Update lib/kitchen/driver/gce_version.rb with the new version.
  2. Update CHANGELOG.md.
  3. Merge to main; the publish workflow builds the gem and pushes it to RubyGems.