Contributing
Add new resource type (ex. Redshift resource)
- Create your feature branch (
git checkout -b add-type-redshift
) - Generate template files (
bundle exec bin/toolbox template redshift
) - Fill files with code.
bundle update
to update gems.- Generate doc/resource_types.md (
bundle exec bin/toolbox docgen > doc/resource_types.md
) - Run test (
bundle exec rake spec
) - Push to the branch (
git push origin add-type-redshift
) - Create a new Pull Request
Troubleshooting
CI Failed 'Awspec::Generator::Doc::Type generate_doc output should be the same as doc/resource_types.md'
Maybe, your aws-sdk-ruby
is not latest. Please exec bundle update
and bundle exec bin/toolbox docgen > doc/resource_types.md
.
( aws-sdk-ruby
is often updated. )
Add new account attribute type (ex. CloudFormation::Client#describe_account_attributes )
- Create your feature branch (
git checkout -b add-type-cf-limit
) - Generate template files (
bundle exec bin/toolbox template cloudformation_account_attributes -a
) with -a option - Fill files with code.
- Generate doc/resource_types.md (
bundle exec bin/toolbox docgen > doc/resource_types.md
) - Run test (
bundle exec rake spec
) - Push to the branch (
git push origin add-type-cf-limit
) - Create a new Pull Request
Append resource type document (ex. VPC resource be_available
)
- Create vpc.md (
touch doc/_resource_types/vpc.md
) - Write following document.
### be_available
(Write cool description)
```ruby
describe vpc('my-vpc') do
it { should be_available }
end
```