knife-ec2 0.18.0 → 0.18.2

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 734b0e6c5929ce79f6ddf8a829920e8789fa3e8c
4
- data.tar.gz: abcebcb7e4ae42eef0051b0aa505bc89c4d72873
2
+ SHA256:
3
+ metadata.gz: 0a82e2799872d734ac239029be1fdbac5babaffb9a87a961d9c6e27ee999fa31
4
+ data.tar.gz: f455dfad31d7b24e83d211b7da5eaa73c2dde85011291f54b4bf769d5e08585d
5
5
  SHA512:
6
- metadata.gz: dafdfbaf8f511db58a17e0bc519ffeae58be4805247068aecf73e3f4d67ab7a5fcc8fb681450e0d4515171e557cd294375477fb72d51928943872e0f8b0518e4
7
- data.tar.gz: 1ecf06ea19040b5b893e4d987b5049e0c87549b63447161bcf08507275ecdc5e0333fa4f6b98ef0d5b24e6404f141e709c217cce82226c1f105311b68ee98211
6
+ metadata.gz: b76e7859c0e5dce52658d9762edd269a3b3b6ef4fc6f35f38f19f91529c493430702d2fc87a3de2015a266d7334915b2747959232e148804c8e4a096e23086aa
7
+ data.tar.gz: 53d04b84f41c0e02fcf03e671eacbbb2e0505bfee68374fe037c2883e2e1fec35e838ac0ef1def79ce27b7a1021f15bf2f7afc37119c665814b681645ba0d65e
@@ -0,0 +1,41 @@
1
+ # Documentation available at http://expeditor.es.chef.io
2
+
3
+ # Slack channel in Chef Software slack to send notifications about build failures, etc
4
+ slack:
5
+ notify_channel: sustaining-notify
6
+
7
+ rubygems:
8
+ - knife-ec2
9
+
10
+ github:
11
+ # The tag format to use (e.g. v1.0.0)
12
+ version_tag_format: "v{{version}}"
13
+ delete_branch_on_merge: true
14
+ # Which Github branches to build gems from, and what versions
15
+ # (as determined by the value in the VERSION file) those branches are responsible
16
+ # for building.
17
+ release_branch:
18
+ - master:
19
+ version_constraint: 0.*
20
+
21
+ promote:
22
+ action:
23
+ - built_in:publish_rubygems
24
+ - built_in:rollover_changelog
25
+
26
+ # These actions are taken, in order they are specified, anytime a Pull Request is merged.
27
+ merge_actions:
28
+ - built_in:bump_version:
29
+ ignore_labels:
30
+ - "Version: Skip Bump"
31
+ - "Expeditor: Skip Version Bump"
32
+ - "Expeditor: Skip All"
33
+ - bash:.expeditor/update_version.sh:
34
+ only_if: built_in:bump_version
35
+ - built_in:update_changelog:
36
+ ignore_labels:
37
+ - "Meta: Exclude From Changelog"
38
+ - "Expeditor: Exclude From Changelog"
39
+ - "Expeditor: Skip All"
40
+ - built_in:build_gem:
41
+ only_if: built_in:bump_version
@@ -0,0 +1,12 @@
1
+ #!/bin/sh
2
+ #
3
+ # After a PR merge, Chef Expeditor will bump the PATCH version in the VERSION file.
4
+ # It then executes this file to update any other files/components with that new version.
5
+ #
6
+
7
+ set -evx
8
+
9
+ sed -i -r "s/^(\s*)VERSION = \".+\"/\1VERSION = \"$(cat VERSION)\"/" lib/knife-ec2/version.rb
10
+
11
+ # Once Expeditor finshes executing this script, it will commit the changes and push
12
+ # the commit as a new tag corresponding to the value in the VERSION file.
data/.gitignore CHANGED
@@ -1,41 +1,41 @@
1
- .rake_tasks~
2
- tags
3
- coverage
4
- rdoc
5
- pkg
6
- test/tmp
7
- test/version_tmp
8
- tmp
9
- pkg
10
- *.gem
11
- *.rbc
12
- lib/bundler/man
13
- spec/reports
14
- .config
15
- InstalledFiles
16
- .bundle
17
-
18
- # YARD artifacts
19
- .yardoc
20
- _yardoc
21
- doc/
22
-
23
- .DS_Store
24
- Icon?
25
-
26
- # Thumbnails
27
- ._*
28
-
29
- # Files that might appear on external disk
30
- .Spotlight-V100
31
- .Trashes
32
-
33
- *.swp
34
- *.swo
35
-
36
- Gemfile.lock
37
- Guardfile
38
- .rspec
39
-
40
- .rvmrc
41
- .rbenv-gemsets
1
+ .rake_tasks~
2
+ tags
3
+ coverage
4
+ rdoc
5
+ pkg
6
+ test/tmp
7
+ test/version_tmp
8
+ tmp
9
+ pkg
10
+ *.gem
11
+ *.rbc
12
+ lib/bundler/man
13
+ spec/reports
14
+ .config
15
+ InstalledFiles
16
+ .bundle
17
+
18
+ # YARD artifacts
19
+ .yardoc
20
+ _yardoc
21
+ doc/
22
+
23
+ .DS_Store
24
+ Icon?
25
+
26
+ # Thumbnails
27
+ ._*
28
+
29
+ # Files that might appear on external disk
30
+ .Spotlight-V100
31
+ .Trashes
32
+
33
+ *.swp
34
+ *.swo
35
+
36
+ Gemfile.lock
37
+ Guardfile
38
+ .rspec
39
+
40
+ .rvmrc
41
+ .rbenv-gemsets
@@ -1,117 +1,132 @@
1
- # knife-ec2 change log
2
-
3
- Note: this log contains only changes from knife-ec2 release 0.8.0 and later
4
- -- it does not contain the changes from prior releases. To view change history
5
- prior to release 0.8.0, please visit the [source repository](https://github.com/chef/knife-ec2/commits).
6
-
7
-
8
- ## Latest Release 0.18.0 (2018-04-05)
9
- * [knife-ec2:#520](https://github.com/chef/knife-ec2/pull/520) Options `--aws-tag` and `--chef-tag` are added for tagging EC2 instance in AWS and Chef separately.
10
-
11
- ## Release 0.17.0 (2018-02-07)
12
- * [knife-ec2:#515](https://github.com/chef/knife-ec2/pull/515) Allow re-use of existing ENI for primary interface.
13
- * [knife-ec2:#514](https://github.com/chef/knife-ec2/pull/514) Add `--instance-initiated-shutdown-behavior` option.
14
- * [knife-ec2:#513](https://github.com/chef/knife-ec2/pull/513) require `rb-readline` to avoid ruby 2.4 warnings about `Fixnum`.
15
-
16
- ## Release 0.16.0 (2017-11-07)
17
- * [knife-ec2:#503](https://github.com/chef/knife-ec2/pull/503) Update list of instance_types that support ebs-encryption.
18
- * [knife-ec2:#496](https://github.com/chef/knife-ec2/pull/496) Change Winrm cert to 10 year expiry.
19
- * [knife-ec2:#492](https://github.com/chef/knife-ec2/pull/492) Added support to tag node details to chef.
20
- * [knife-ec2:#490](https://github.com/chef/knife-ec2/pull/490) Improper alignment of EC2 flavor list.
21
- * [knife-ec2:#489](https://github.com/chef/knife-ec2/pull/489) Added support to handle long passwords in windows.
22
- * [knife-ec2:#488](https://github.com/chef/knife-ec2/pull/488) Added support to tag EBS volumes on node creation.
23
- * [knife-ec2:#487](https://github.com/chef/knife-ec2/pull/487) Added new column description in EC2 AMIs list.
24
-
25
- ## Release 0.15.0 (2017-02-15)
26
- * [knife-ec2:#484](https://github.com/chef/knife-ec2/pull/484) sleep for collecting windows password
27
- * [knife-ec2:#481](https://github.com/chef/knife-ec2/pull/481) Updated readme for EC2 AMI list
28
- * [knife-ec2:#482](https://github.com/chef/knife-ec2/pull/482) Allow search for EC2 AMIs
29
- * [knife-ec2:#471](https://github.com/chef/knife-ec2/pull/471) Added support to include ec2 server id in the node name using `-N "www-server-%s" or --chef-node-name "-www-server-%s"`
30
- * [knife-ec2:#478](https://github.com/chef/knife-ec2/pull/478) Allow for hosts without public ip addresses
31
- * [knife-ec2:#476](https://github.com/chef/knife-ec2/pull/476) Tag node in chef
32
- * [knife-ec2:#458](https://github.com/chef/knife-ec2/pull/458) Fix where yes option wasn’t being passed to bootstrap
33
- * [knife-ec2:#468](https://github.com/chef/knife-ec2/pull/468) In VPC mode use private IP when public IP and DNS not available
34
- * [knife-ec2:#464](https://github.com/chef/knife-ec2/pull/464) default value and desription is changed for --ebs-volume-type
35
-
36
- ## Release 0.14.0 (2016-12-02)
37
- * `knife-ec2` requires `chef-client 12.14` or newer.
38
- * [knife-ec2:#442](https://github.com/chef/knife-ec2/pull/442) Added support to show flavor list in json format.
39
- * [knife-ec2:#439](https://github.com/chef/knife-ec2/pull/439) Allow to accept multiple security group ids using --security-group-id option multiple times and added deprecated message for comma seprated --security-group-ids option.
40
-
41
- ## Release 0.13.0 (2016-08-05)
42
- * [knife-ec2:#438](https://github.com/chef/knife-ec2/pull/438) Specs for ec2 server list
43
- * [knife-ec2:#437](https://github.com/chef/knife-ec2/pull/437) Fix --aws-credential-file issues
44
- * [knife-ec2:#436](https://github.com/chef/knife-ec2/pull/436) basic is not a valid setting for winrm_ssl_verify_mode
45
- * [knife-ec2:#435](https://github.com/chef/knife-ec2/pull/435) Fix for Winrm Authentication Failure issue during bootstrap
46
- * [knife-ec2:#434](https://github.com/chef/knife-ec2/pull/434) Removed ruby2.0.0 from travis
47
- * [knife-ec2:#431](https://github.com/chef/knife-ec2/pull/431) Pinned rack and ffi-yajl gem to older versions.
48
- * [knife-ec2:#430](https://github.com/chef/knife-ec2/pull/430) Fixing --aws-config-file issues
49
- * [knife-ec2:#429](https://github.com/chef/knife-ec2/pull/429) Added validation when spot-wait-mode option is given by user on CLI and spot-price option is not given.
50
- * [knife-ec2:#428](https://github.com/chef/knife-ec2/pull/428) Fix for s3 secret not getting copied on target vm
51
- * [knife-ec2:#427](https://github.com/chef/knife-ec2/pull/427) Addedd disable_api_termination option along with RSpecs.
52
- * [knife-ec2:#416](https://github.com/chef/knife-ec2/pull/416) Modified help for option --security-group-ids
53
- * [knife-ec2:#409](https://github.com/chef/knife-ec2/pull/409) Passing encrypted\_data\_bag\_secret and encrypted\_databag\_secret\_file
54
- * [knife-ec2:#405](https://github.com/chef/knife-ec2/pull/405) Updated README file - added description of aws\_config\_file option
55
- * [knife-ec2:#399](https://github.com/chef/knife-ec2/pull/399) Adding support for aws-config-file
56
- * [knife-ec2:#400](https://github.com/chef/knife-ec2/pull/400) Added --json-for-attributes-file
57
- * [knife-ec2:#393](https://github.com/chef/knife-ec2/pull/393) Please also read aws\_session\_token from credentials file - [Richard Morrisey](https://github.com/datascope)
58
- * [knife-ec2:#395](https://github.com/chef/knife-ec2/pull/395) Fix security groups for spot requests in a VPC and make user input optional - [Mikhail Bautin](https://github.com/mbautin)
59
- * [knife-ec2:#322](https://github.com/chef/knife-ec2/pull/322) Implement support for ClassicLink [Quention de Metz](https://github.com/quentindemetz)
60
- * [knife-ec2:#391](https://github.com/chef/knife-ec2/pull/391) adding missing m4,d2,t2,and g2 ebs encryption flavors - [Mario Harvey](https://github.com/badmadrad)
61
- * [knife-ec2:#390](https://github.com/chef/knife-ec2/pull/390) Modified create\_ssl\_listener option as per Mixlib-CLI.
62
- * [knife-ec2:#375](https://github.com/chef/knife-ec2/pull/375) Attach network interfaces before bootstrap - [Eric Herot](https://github.com/eherot)
63
- * [knife-ec2:#389](https://github.com/chef/knife-ec2/pull/389) --server-connect-attribute cleanup
64
- * [knife-ec2:#388](https://github.com/chef/knife-ec2/pull/388) Updated Readme for --server-connect-attribute option
65
- * [knife-ec2:#384](https://github.com/chef/knife-ec2/pull/384) server list in json format
66
- * [knife-ec2:#378](https://github.com/chef/knife-ec2/pull/378) Readme improvements
67
- * [knife-ec2:#376](https://github.com/chef/knife-ec2/pull/376) Remove instance colors
68
- * [knife-ec2:#377](https://github.com/chef/knife-ec2/pull/377) Require fog-aws vs. fog
69
- * [knife-ec2:#368](https://github.com/chef/knife-ec2/pull/368) Handle Errno::ENOTCONN when testing for sshd access - [Eugene Bolshakov](https://github.com/eugenebolshakov)
70
- * [knife-ec2:#373](https://github.com/chef/knife-ec2/pull/373) Update contributing docs
71
- * [knife-ec2:#374](https://github.com/chef/knife-ec2/pull/374) Avoid sending nil runlist to Chef::Knife::Boostrap
72
- * [knife-ec2:#372](https://github.com/chef/knife-ec2/pull/372) Cache gems in travis, update links and opscode -> chef
73
- * [knife-ec2:#371](https://github.com/chef/knife-ec2/pull/371) fix typo in readme - [Kyle West](https://github.com/kylewest)
74
- * [knife-ec2:#363](https://github.com/chef/knife-ec2/pull/363) Add ssl config user data for ssl transport, if required append to user\_data script specified by user.
75
- * [knife-ec2:#319](https://github.com/chef/knife-ec2/pull/319) Pointing docs at itself. This is better then the non-existent chef.io docs.
76
-
77
- ## Release: 0.12.0 (2015-10-1)
78
- * [knife-ec2:#305](https://github.com/chef/knife-ec2/pull/305) Updates to support standard .aws/credentials file
79
- * [knife-ec2 #354](https://github.com/chef/knife-ec2/pull/354) knife-windows 1.0.0 dependency, support for validatorless bootstrap, other Chef 12 bootstrap options
80
- * [knife-ec2 #356](https://github.com/chef/knife-ec2/pull/356) Added --forward-agent option
81
-
82
- ## Release: 0.11.0 (2015-08-24)
83
- * [knife-ec2:#330](https://github.com/chef/knife-ec2/pull/330) Modification for attribute precedence issue
84
- * [knife-ec2:#293](https://github.com/chef/knife-ec2/pull/293) s3_source: Lazy load fog library
85
- * [knife-ec2:#284](https://github.com/chef/knife-ec2/pull/284) Enable Spot Pricing
86
- * [knife-ec2:#280](https://github.com/chef/knife-ec2/pull/280) Support for EBS volume encryption in knife-ec2 server create options
87
- * [knife-ec2:#273](https://github.com/chef/knife-ec2/pull/273) Remove -s option for data bag secret and subnets
88
- * [knife-ec2:#268](https://github.com/chef/knife-ec2/pull/268) Updated gemspec to use fog v1.25
89
- * [knife-ec2:#265](https://github.com/chef/knife-ec2/pull/265) showing error message for incorrect option input
90
- * [knife-ec2:#261](https://github.com/chef/knife-ec2/pull/261) Remove 'em-winrm' gem dependency
91
- * [KNIFE-464](https://tickets.opscode.com/browse/KNIFE-464) Support EC2 STS, i.e. AWS Federation tokens for authentication
92
-
93
- ## Release: 0.10.0.rc.1 (2014-10-08)
94
- * [Issue:#237](https://github.com/chef/knife-ec2/issues/237) Provide a way to the validation key and data bag secret from S3
95
- * [Issue:#243](https://github.com/chef/knife-ec2/issues/243) Support new AWS CLI configuration file format
96
- * Update `knife-windows` gem dependency to `knife-windows 0.8.rc.0` for improved Windows authentication integration
97
- * Update `fog` gem dependency to `fog 1.23.0`
98
- * Provisioned IOPS support via the `--provisioned-iops` and `--ebs-volume-type` options
99
- * [KNIFE-466](https://tickets.opscode.com/browse/KNIFE-466) Knife ec2 should use gateway from net::ssh config if available
100
- * [KNIFE-422](https://tickets.opscode.com/browse/KNIFE-422) Knife ec2 server create doesn't respect identity file of gateway server from ssh\_config
101
-
102
- ## Release: 0.8.0 (2014-03-10)
103
- * [KNIFE-458](https://tickets.opscode.com/browse/KNIFE-458) Docs: Increase detail about necessary
104
- options for VPC instance creation
105
- * [KNIFE-456](https://tickets.opscode.com/browse/KNIFE-456) Documentation for :aws\_credential\_file difficult to read
106
- * [KNIFE-455](https://tickets.opscode.com/browse/KNIFE-455) knife ec2 may try to use private ip for vpc bootstrap even with --associate-public-ip flag
107
- * [KNIFE-453](https://tickets.opscode.com/browse/KNIFE-453) knife-ec2 doesn't handle aws credentials files with windows line endings
108
- * [KNIFE-451](https://tickets.opscode.com/browse/KNIFE-451) Update Fog version to 1.20.0
109
- * [KNIFE-430](https://tickets.opscode.com/browse/KNIFE-430) server creation tunnelling should wait for a valid banner before continuing
110
- * [KNIFE-381](https://tickets.opscode.com/browse/KNIFE-381) Gabriel Rosendorf Add ability to associate public ip with VPC
111
- instance on creation
112
-
113
- ## Releases prior to 0.8.0
114
- Please see <https://github.com/chef/knife-ec2/commits> to view changes in
115
- the form of commits to the source repository for releases before 0.8.0.
116
-
117
-
1
+ # knife-ec2 change log
2
+
3
+ Note: this log contains only changes from knife-ec2 release 0.8.0 and later
4
+ -- it does not contain the changes from prior releases. To view change history
5
+ prior to release 0.8.0, please visit the [source repository](https://github.com/chef/knife-ec2/commits).
6
+
7
+ <!-- latest_release 0.18.2 -->
8
+ ## [v0.18.2](https://github.com/chef/knife-ec2/tree/v0.18.2) (2018-07-05)
9
+
10
+ #### Merged Pull Requests
11
+ - MSYS-798 - Fixes for windows administrator password [#524](https://github.com/chef/knife-ec2/pull/524) ([dheerajd-msys](https://github.com/dheerajd-msys))
12
+ <!-- latest_release -->
13
+
14
+ <!-- release_rollup since=0.18.0 -->
15
+ ### Changes since 0.18.0 release
16
+
17
+ #### Merged Pull Requests
18
+ - MSYS-798 - Fixes for windows administrator password [#524](https://github.com/chef/knife-ec2/pull/524) ([dheerajd-msys](https://github.com/dheerajd-msys)) <!-- 0.18.2 -->
19
+ - [MSYS-824] fix breaking tag changes &amp; deprecation warning [#527](https://github.com/chef/knife-ec2/pull/527) ([dheerajd-msys](https://github.com/dheerajd-msys)) <!-- 0.18.1 -->
20
+ <!-- release_rollup -->
21
+
22
+ <!-- latest_stable_release -->
23
+ <!-- latest_stable_release -->
24
+
25
+ ## Latest Release 0.18.0 (2018-04-05)
26
+ * [knife-ec2:#520](https://github.com/chef/knife-ec2/pull/520) Options `--aws-tag` and `--chef-tag` are added for tagging EC2 instance in AWS and Chef separately.
27
+
28
+ ## Release 0.17.0 (2018-02-07)
29
+ * [knife-ec2:#515](https://github.com/chef/knife-ec2/pull/515) Allow re-use of existing ENI for primary interface.
30
+ * [knife-ec2:#514](https://github.com/chef/knife-ec2/pull/514) Add `--instance-initiated-shutdown-behavior` option.
31
+ * [knife-ec2:#513](https://github.com/chef/knife-ec2/pull/513) require `rb-readline` to avoid ruby 2.4 warnings about `Fixnum`.
32
+
33
+ ## Release 0.16.0 (2017-11-07)
34
+ * [knife-ec2:#503](https://github.com/chef/knife-ec2/pull/503) Update list of instance_types that support ebs-encryption.
35
+ * [knife-ec2:#496](https://github.com/chef/knife-ec2/pull/496) Change Winrm cert to 10 year expiry.
36
+ * [knife-ec2:#492](https://github.com/chef/knife-ec2/pull/492) Added support to tag node details to chef.
37
+ * [knife-ec2:#490](https://github.com/chef/knife-ec2/pull/490) Improper alignment of EC2 flavor list.
38
+ * [knife-ec2:#489](https://github.com/chef/knife-ec2/pull/489) Added support to handle long passwords in windows.
39
+ * [knife-ec2:#488](https://github.com/chef/knife-ec2/pull/488) Added support to tag EBS volumes on node creation.
40
+ * [knife-ec2:#487](https://github.com/chef/knife-ec2/pull/487) Added new column description in EC2 AMIs list.
41
+
42
+ ## Release 0.15.0 (2017-02-15)
43
+ * [knife-ec2:#484](https://github.com/chef/knife-ec2/pull/484) sleep for collecting windows password
44
+ * [knife-ec2:#481](https://github.com/chef/knife-ec2/pull/481) Updated readme for EC2 AMI list
45
+ * [knife-ec2:#482](https://github.com/chef/knife-ec2/pull/482) Allow search for EC2 AMIs
46
+ * [knife-ec2:#471](https://github.com/chef/knife-ec2/pull/471) Added support to include ec2 server id in the node name using `-N "www-server-%s" or --chef-node-name "-www-server-%s"`
47
+ * [knife-ec2:#478](https://github.com/chef/knife-ec2/pull/478) Allow for hosts without public ip addresses
48
+ * [knife-ec2:#476](https://github.com/chef/knife-ec2/pull/476) Tag node in chef
49
+ * [knife-ec2:#458](https://github.com/chef/knife-ec2/pull/458) Fix where yes option wasn’t being passed to bootstrap
50
+ * [knife-ec2:#468](https://github.com/chef/knife-ec2/pull/468) In VPC mode use private IP when public IP and DNS not available
51
+ * [knife-ec2:#464](https://github.com/chef/knife-ec2/pull/464) default value and desription is changed for --ebs-volume-type
52
+
53
+ ## Release 0.14.0 (2016-12-02)
54
+ * `knife-ec2` requires `chef-client 12.14` or newer.
55
+ * [knife-ec2:#442](https://github.com/chef/knife-ec2/pull/442) Added support to show flavor list in json format.
56
+ * [knife-ec2:#439](https://github.com/chef/knife-ec2/pull/439) Allow to accept multiple security group ids using --security-group-id option multiple times and added deprecated message for comma seprated --security-group-ids option.
57
+
58
+ ## Release 0.13.0 (2016-08-05)
59
+ * [knife-ec2:#438](https://github.com/chef/knife-ec2/pull/438) Specs for ec2 server list
60
+ * [knife-ec2:#437](https://github.com/chef/knife-ec2/pull/437) Fix --aws-credential-file issues
61
+ * [knife-ec2:#436](https://github.com/chef/knife-ec2/pull/436) basic is not a valid setting for winrm_ssl_verify_mode
62
+ * [knife-ec2:#435](https://github.com/chef/knife-ec2/pull/435) Fix for Winrm Authentication Failure issue during bootstrap
63
+ * [knife-ec2:#434](https://github.com/chef/knife-ec2/pull/434) Removed ruby2.0.0 from travis
64
+ * [knife-ec2:#431](https://github.com/chef/knife-ec2/pull/431) Pinned rack and ffi-yajl gem to older versions.
65
+ * [knife-ec2:#430](https://github.com/chef/knife-ec2/pull/430) Fixing --aws-config-file issues
66
+ * [knife-ec2:#429](https://github.com/chef/knife-ec2/pull/429) Added validation when spot-wait-mode option is given by user on CLI and spot-price option is not given.
67
+ * [knife-ec2:#428](https://github.com/chef/knife-ec2/pull/428) Fix for s3 secret not getting copied on target vm
68
+ * [knife-ec2:#427](https://github.com/chef/knife-ec2/pull/427) Addedd disable_api_termination option along with RSpecs.
69
+ * [knife-ec2:#416](https://github.com/chef/knife-ec2/pull/416) Modified help for option --security-group-ids
70
+ * [knife-ec2:#409](https://github.com/chef/knife-ec2/pull/409) Passing encrypted\_data\_bag\_secret and encrypted\_databag\_secret\_file
71
+ * [knife-ec2:#405](https://github.com/chef/knife-ec2/pull/405) Updated README file - added description of aws\_config\_file option
72
+ * [knife-ec2:#399](https://github.com/chef/knife-ec2/pull/399) Adding support for aws-config-file
73
+ * [knife-ec2:#400](https://github.com/chef/knife-ec2/pull/400) Added --json-for-attributes-file
74
+ * [knife-ec2:#393](https://github.com/chef/knife-ec2/pull/393) Please also read aws\_session\_token from credentials file - [Richard Morrisey](https://github.com/datascope)
75
+ * [knife-ec2:#395](https://github.com/chef/knife-ec2/pull/395) Fix security groups for spot requests in a VPC and make user input optional - [Mikhail Bautin](https://github.com/mbautin)
76
+ * [knife-ec2:#322](https://github.com/chef/knife-ec2/pull/322) Implement support for ClassicLink [Quention de Metz](https://github.com/quentindemetz)
77
+ * [knife-ec2:#391](https://github.com/chef/knife-ec2/pull/391) adding missing m4,d2,t2,and g2 ebs encryption flavors - [Mario Harvey](https://github.com/badmadrad)
78
+ * [knife-ec2:#390](https://github.com/chef/knife-ec2/pull/390) Modified create\_ssl\_listener option as per Mixlib-CLI.
79
+ * [knife-ec2:#375](https://github.com/chef/knife-ec2/pull/375) Attach network interfaces before bootstrap - [Eric Herot](https://github.com/eherot)
80
+ * [knife-ec2:#389](https://github.com/chef/knife-ec2/pull/389) --server-connect-attribute cleanup
81
+ * [knife-ec2:#388](https://github.com/chef/knife-ec2/pull/388) Updated Readme for --server-connect-attribute option
82
+ * [knife-ec2:#384](https://github.com/chef/knife-ec2/pull/384) server list in json format
83
+ * [knife-ec2:#378](https://github.com/chef/knife-ec2/pull/378) Readme improvements
84
+ * [knife-ec2:#376](https://github.com/chef/knife-ec2/pull/376) Remove instance colors
85
+ * [knife-ec2:#377](https://github.com/chef/knife-ec2/pull/377) Require fog-aws vs. fog
86
+ * [knife-ec2:#368](https://github.com/chef/knife-ec2/pull/368) Handle Errno::ENOTCONN when testing for sshd access - [Eugene Bolshakov](https://github.com/eugenebolshakov)
87
+ * [knife-ec2:#373](https://github.com/chef/knife-ec2/pull/373) Update contributing docs
88
+ * [knife-ec2:#374](https://github.com/chef/knife-ec2/pull/374) Avoid sending nil runlist to Chef::Knife::Boostrap
89
+ * [knife-ec2:#372](https://github.com/chef/knife-ec2/pull/372) Cache gems in travis, update links and opscode -> chef
90
+ * [knife-ec2:#371](https://github.com/chef/knife-ec2/pull/371) fix typo in readme - [Kyle West](https://github.com/kylewest)
91
+ * [knife-ec2:#363](https://github.com/chef/knife-ec2/pull/363) Add ssl config user data for ssl transport, if required append to user\_data script specified by user.
92
+ * [knife-ec2:#319](https://github.com/chef/knife-ec2/pull/319) Pointing docs at itself. This is better then the non-existent chef.io docs.
93
+
94
+ ## Release: 0.12.0 (2015-10-1)
95
+ * [knife-ec2:#305](https://github.com/chef/knife-ec2/pull/305) Updates to support standard .aws/credentials file
96
+ * [knife-ec2 #354](https://github.com/chef/knife-ec2/pull/354) knife-windows 1.0.0 dependency, support for validatorless bootstrap, other Chef 12 bootstrap options
97
+ * [knife-ec2 #356](https://github.com/chef/knife-ec2/pull/356) Added --forward-agent option
98
+
99
+ ## Release: 0.11.0 (2015-08-24)
100
+ * [knife-ec2:#330](https://github.com/chef/knife-ec2/pull/330) Modification for attribute precedence issue
101
+ * [knife-ec2:#293](https://github.com/chef/knife-ec2/pull/293) s3_source: Lazy load fog library
102
+ * [knife-ec2:#284](https://github.com/chef/knife-ec2/pull/284) Enable Spot Pricing
103
+ * [knife-ec2:#280](https://github.com/chef/knife-ec2/pull/280) Support for EBS volume encryption in knife-ec2 server create options
104
+ * [knife-ec2:#273](https://github.com/chef/knife-ec2/pull/273) Remove -s option for data bag secret and subnets
105
+ * [knife-ec2:#268](https://github.com/chef/knife-ec2/pull/268) Updated gemspec to use fog v1.25
106
+ * [knife-ec2:#265](https://github.com/chef/knife-ec2/pull/265) showing error message for incorrect option input
107
+ * [knife-ec2:#261](https://github.com/chef/knife-ec2/pull/261) Remove 'em-winrm' gem dependency
108
+ * [KNIFE-464](https://tickets.opscode.com/browse/KNIFE-464) Support EC2 STS, i.e. AWS Federation tokens for authentication
109
+
110
+ ## Release: 0.10.0.rc.1 (2014-10-08)
111
+ * [Issue:#237](https://github.com/chef/knife-ec2/issues/237) Provide a way to the validation key and data bag secret from S3
112
+ * [Issue:#243](https://github.com/chef/knife-ec2/issues/243) Support new AWS CLI configuration file format
113
+ * Update `knife-windows` gem dependency to `knife-windows 0.8.rc.0` for improved Windows authentication integration
114
+ * Update `fog` gem dependency to `fog 1.23.0`
115
+ * Provisioned IOPS support via the `--provisioned-iops` and `--ebs-volume-type` options
116
+ * [KNIFE-466](https://tickets.opscode.com/browse/KNIFE-466) Knife ec2 should use gateway from net::ssh config if available
117
+ * [KNIFE-422](https://tickets.opscode.com/browse/KNIFE-422) Knife ec2 server create doesn't respect identity file of gateway server from ssh\_config
118
+
119
+ ## Release: 0.8.0 (2014-03-10)
120
+ * [KNIFE-458](https://tickets.opscode.com/browse/KNIFE-458) Docs: Increase detail about necessary
121
+ options for VPC instance creation
122
+ * [KNIFE-456](https://tickets.opscode.com/browse/KNIFE-456) Documentation for :aws\_credential\_file difficult to read
123
+ * [KNIFE-455](https://tickets.opscode.com/browse/KNIFE-455) knife ec2 may try to use private ip for vpc bootstrap even with --associate-public-ip flag
124
+ * [KNIFE-453](https://tickets.opscode.com/browse/KNIFE-453) knife-ec2 doesn't handle aws credentials files with windows line endings
125
+ * [KNIFE-451](https://tickets.opscode.com/browse/KNIFE-451) Update Fog version to 1.20.0
126
+ * [KNIFE-430](https://tickets.opscode.com/browse/KNIFE-430) server creation tunnelling should wait for a valid banner before continuing
127
+ * [KNIFE-381](https://tickets.opscode.com/browse/KNIFE-381) Gabriel Rosendorf Add ability to associate public ip with VPC
128
+ instance on creation
129
+
130
+ ## Releases prior to 0.8.0
131
+ Please see <https://github.com/chef/knife-ec2/commits> to view changes in
132
+ the form of commits to the source repository for releases before 0.8.0.
@@ -1,216 +1,245 @@
1
- # Contributing to knife-ec2
2
-
3
- We're glad you want to contribute to knife-ec2! The first
4
- step is the desire to improve the project.
5
-
6
- ## Quick Contributing Steps
7
-
8
- 1. Create an account on [GitHub](https://github.com).
9
- 2. Create an account on the [Chef Supermarket](https://supermarket.chef.io/).
10
- 3. [Become a contributor](https://supermarket.chef.io/become-a-contributor) by
11
- signing our Contributor License Agreement (CLA).
12
- 4. Create a pull request for your change on [GitHub](https://github.com/chef/knife-ec2/pulls).
13
- 5. The knife-ec2 maintainers will review your change, and either merge the
14
- change or offer suggestions.
15
-
16
- ## The Apache License and the CLA/CCLA
17
- Licensing is very important to open source projects. It helps ensure the
18
- software continues to be available under the terms that the author desired.
19
-
20
- Chef uses [the Apache 2.0 license](http://www.apache.org/licenses/LICENSE-2.0)
21
- to strike a balance between open contribution and allowing you to use the
22
- software however you would like to.
23
-
24
- The license tells you what rights you have that are provided by the copyright
25
- holder. It is important that the contributor fully understands what rights they
26
- are licensing and agrees to them. Sometimes the copyright holder isn't the
27
- contributor, such as when the contributor is doing work for a company.
28
-
29
- To make a good faith effort to ensure these criteria are met, Chef requires an
30
- Individual CLA or a Corporate CLA for contributions. This agreement helps ensure
31
- you are aware of the terms of the license you are contributing your copyrighted
32
- works under, which helps to prevent the inclusion of works in the projects that
33
- the contributor does not hold the rights to share.
34
-
35
- It only takes a few minutes to complete a CLA, and you retain the copyright to
36
- your contribution.
37
-
38
- You can complete our [Individual
39
- CLA](https://supermarket.chef.io/icla-signatures/new) online. If you're
40
- contributing on behalf of your employer and they retain the copyright for your
41
- works, have your employer fill out our [Corporate
42
- CLA](https://supermarket.chef.io/ccla-signatures/new) instead.
43
-
44
- ### Chef Obvious Fix Policy
45
-
46
- Small contributions such as fixing spelling errors, where the content is small enough
47
- to not be considered intellectual property, can be submitted by a contributor as a patch,
48
- without a CLA.
49
-
50
- As a rule of thumb, changes are obvious fixes if they do not introduce any new functionality
51
- or creative thinking. As long as the change does not affect functionality. Some likely
52
- examples include the following:
53
-
54
- * Spelling / grammar fixes
55
- * Typo correction, white space and formatting changes
56
- * Comment clean up
57
- * Bug fixes that change default return values or error codes stored in constants
58
- * Adding logging messages or debugging output
59
- * Changes to ‘metadata’ files like Gemfile, .gitignore, build scripts, etc.
60
- * Moving source files from one directory or package to another
61
-
62
- **Whenever you invoke the “obvious fix” rule, please say so in your commit message:**
63
-
64
- ```
65
- ------------------------------------------------------------------------
66
- commit 370adb3f82d55d912b0cf9c1d1e99b132a8ed3b5
67
- Author: juliachild <julia@chef.io>
68
- Date: Wed Sep 18 11:44:40 2015 -0700
69
-
70
- Fix typo in the README.
71
-
72
- Obvious fix.
73
-
74
- ------------------------------------------------------------------------
75
- ```
76
-
77
- ## <a name="issues"></a>Issue Tracking
78
-
79
- Chef uses Github Issues to track issues with knife-ec2. Issues should be
80
- submitted at https://github.com/chef/knife-ec2/issues/new.
81
-
82
- In order to decrease the back and forth in issues, and to help us get to
83
- the bottom of them quickly we use the below issue template. You can copy/paste
84
- this template into the issue you are opening and edit it accordingly.
85
-
86
- <a name="issuetemplate"></a>
87
- ```
88
- ### Environment: [Details about the environment such as the Operating System, Ruby release, etc...]
89
-
90
- ### Scenario:
91
- [What you are trying to achieve and you can't?]
92
-
93
-
94
- ### Steps to Reproduce:
95
- [If you are filing an issue what are the things we need to do in order to repro your problem?]
96
-
97
-
98
- ### Expected Result:
99
- [What are you expecting to happen as the consequence of above reproduction steps?]
100
-
101
-
102
- ### Actual Result:
103
- [What actually happens after the reproduction steps?]
104
- ```
105
-
106
- ## Using git
107
-
108
- You can copy the knife-ec2 repository to your local workstation by running
109
- `git clone git://github.com/chef/knife-ec2.git`.
110
-
111
- For collaboration purposes, it is best if you create a GitHub account
112
- and fork the repository to your own account. Once you do this you will
113
- be able to push your changes to your GitHub repository for others to
114
- see and use.
115
-
116
- ### Branches and Commits
117
-
118
- You should submit your patch as a git branch named after the Github
119
- issue, such as GH-22. This is called a _topic branch_ and allows users
120
- to associate a branch of code with the ticket.
121
-
122
- It is a best practice to have your commit message have a _summary
123
- line_ that includes the ticket number, followed by an empty line and
124
- then a brief description of the commit. This also helps other
125
- contributors understand the purpose of changes to the code.
126
-
127
- ```text
128
- [GH-22] - platform_family and style
129
-
130
- * use platform_family for platform checking
131
- * update notifies syntax to "resource_type[resource_name]" instead of
132
- resources() lookup
133
- * GH-692 - delete config files dropped off by packages in conf.d
134
- * dropped debian 4 support because all other platforms have the same
135
- values, and it is older than "old stable" debian release
136
- ```
137
-
138
- Remember that not all users use Chef in the same way or on the same
139
- operating systems as you, so it is helpful to be clear about your use
140
- case and change so they can understand it even when it doesn't apply
141
- to them.
142
-
143
- ### More information
144
-
145
- Additional help with git is available on the [Community
146
- Contributions](https://docs.chef.io/community_contributions.html#use-git)
147
- page on the Chef Docs site.
148
-
149
- ## Unit Tests
150
-
151
- knife-ec2 is tested with rspec unit tests to ensure changes don't cause
152
- regressions for other use cases. All non-trivial changes must include
153
- additional unit tests.
154
-
155
- To run the rspec tests run the following commands from the root of the
156
- project:
157
-
158
- bundle install
159
- bundle exec rspec spec
160
-
161
- **All tests must pass** before your contribution can be merged. Thus it's a good idea
162
- to execute the tests without your change to be sure you understand how to run
163
- them, as well as after to validate that you've avoided regressions.
164
-
165
- ## Code Review
166
-
167
- Chef Software regularly reviews code contributions and provides suggestions
168
- for improvement in the code itself or the implementation.
169
-
170
- ## Release Cycle
171
-
172
- The versioning for Chef Software projects is X.Y.Z.
173
-
174
- * X is a major release, which may not be fully compatible with prior
175
- major releases
176
- * Y is a minor release, which adds both new features and bug fixes
177
- * Z is a patch release, which adds just bug fixes
178
-
179
- ## Working with the community
180
-
181
- These resources will help you learn more about Chef and connect to
182
- other members of the Chef community:
183
-
184
- * [Chef Community Guidelines](https://docs.chef.io/community_guidelines.html)
185
- * [Chef Mailing List](https://discourse.chef.io/c/dev)
186
- * #chef and #chef-hacking IRC channels on irc.freenode.net
187
- * [Supermarket site](https://supermarket.chef.io/)
188
- * [Chef Docs](http://docs.chef.io)
189
- * Chef Software Chef [product page](https://www.chef.io/chef/)
190
-
191
-
192
- ## Contribution Do's and Don't's
193
-
194
- Please do include tests for your contribution. If you need help, ask on the
195
- [chef-dev mailing list](https://discourse.chef.io/c/dev) or the [#chef-hacking
196
- IRC channel](https://botbot.me/freenode/chef-hacking/). Please provide
197
- evidence of testing your contribution if it isn't trivial so we don't have to
198
- duplicate effort in testing.
199
-
200
- Please do **not** modify the version number of the gem, Chef
201
- will select the appropriate version based on the release cycle
202
- information above.
203
-
204
- Please do **not** update the `CHANGELOG.md` for a new version. Not all
205
- changes may be merged and released in the same versions. Chef Software
206
- will update the `CHANGELOG.md` when releasing a new version.
207
-
208
- ## Further Resources
209
-
210
- ### Fog
211
-
212
- Knife-ec2 uses the Fog gem to interact with EC2's API. When there's a new
213
- feature of EC2 that you'd like to utilize in knife-ec2 use cases, that feature
214
- will probably be exposed by Fog. You can read about Fog
215
- at its [project page](https://github.com/fog/fog).
216
-
1
+ # Contributing to knife-ec2
2
+
3
+ We're glad you want to contribute to knife-ec2! The first
4
+ step is the desire to improve the project.
5
+
6
+ ## Contribution Process
7
+
8
+ We have a 3 step process for contributions:
9
+
10
+ 1. Commit changes to a git branch, making sure to sign-off those changes for the [Developer Certificate of Origin](#developer-certification-of-origin-dco).
11
+ 2. Create a Github Pull Request for your change, following the instructions in the pull request template.
12
+ 3. Perform a [Code Review](#code-review-process) with the project maintainers on the pull request.
13
+
14
+ ### Code Review Process
15
+
16
+ Code review takes place in Github pull requests. See [this article](https://help.github.com/articles/about-pull-requests/) if you're not familiar with Github Pull Requests.
17
+
18
+ Once you open a pull request, project maintainers will review your code and respond to your pull request with any feedback they might have. The process at this point is as follows:
19
+
20
+ 1. Two thumbs-up (:+1:) are required from project maintainers. See the master maintainers document for Chef projects at <https://github.com/chef/chef/blob/master/MAINTAINERS.md>.
21
+ 2. When ready, your pull request will be tagged with label `Ready For Merge`.
22
+ 3. Your change will be merged into the project's `master` branch and will be noted in the project's `CHANGELOG.md` at the time of release.
23
+
24
+ ### Developer Certification of Origin (DCO)
25
+
26
+ Licensing is very important to open source projects. It helps ensure the software continues to be available under the terms that the author desired.
27
+
28
+ Chef uses [the Apache 2.0 license](https://github.com/chef/chef/blob/master/LICENSE) to strike a balance between open contribution and allowing you to use the software however you would like to.
29
+
30
+ The license tells you what rights you have that are provided by the copyright holder. It is important that the contributor fully understands what rights they are licensing and agrees to them. Sometimes the copyright holder isn't the contributor, such as when the contributor is doing work on behalf of a company.
31
+
32
+ To make a good faith effort to ensure these criteria are met, Chef requires the Developer Certificate of Origin (DCO) process to be followed.
33
+
34
+ The DCO is an attestation attached to every contribution made by every developer. In the commit message of the contribution, the developer simply adds a Signed-off-by statement and thereby agrees to the DCO, which you can find below or at <http://developercertificate.org/>.
35
+
36
+ ```
37
+ Developer's Certificate of Origin 1.1
38
+
39
+ By making a contribution to this project, I certify that:
40
+
41
+ (a) The contribution was created in whole or in part by me and I
42
+ have the right to submit it under the open source license
43
+ indicated in the file; or
44
+
45
+ (b) The contribution is based upon previous work that, to the
46
+ best of my knowledge, is covered under an appropriate open
47
+ source license and I have the right under that license to
48
+ submit that work with modifications, whether created in whole
49
+ or in part by me, under the same open source license (unless
50
+ I am permitted to submit under a different license), as
51
+ Indicated in the file; or
52
+
53
+ (c) The contribution was provided directly to me by some other
54
+ person who certified (a), (b) or (c) and I have not modified
55
+ it.
56
+
57
+ (d) I understand and agree that this project and the contribution
58
+ are public and that a record of the contribution (including
59
+ all personal information I submit with it, including my
60
+ sign-off) is maintained indefinitely and may be redistributed
61
+ consistent with this project or the open source license(s)
62
+ involved.
63
+ ```
64
+
65
+ For more information on the change see the Chef Blog post [Introducing Developer Certificate of Origin](https://blog.chef.io/2016/09/19/introducing-developer-certificate-of-origin/)
66
+
67
+ #### DCO Sign-Off Methods
68
+
69
+ The DCO requires a sign-off message in the following format appear on each commit in the pull request:
70
+
71
+ ```
72
+ Signed-off-by: Julia Child <juliachild@chef.io>
73
+ ```
74
+
75
+ The DCO text can either be manually added to your commit body, or you can add either **-s** or **--signoff** to your usual git commit commands. If you forget to add the sign-off you can also amend a previous commit with the sign-off by running **git commit --amend -s**. If you've pushed your changes to Github already you'll need to force push your branch after this with **git push -f**.
76
+
77
+ ### Chef Obvious Fix Policy
78
+
79
+ Small contributions, such as fixing spelling errors, where the content is small enough to not be considered intellectual property, can be submitted without signing the contribution for the DCO.
80
+
81
+ As a rule of thumb, changes are obvious fixes if they do not introduce any new functionality or creative thinking. Assuming the change does not affect functionality, some common obvious fix examples include the following:
82
+
83
+ - Spelling / grammar fixes
84
+ - Typo correction, white space and formatting changes
85
+ - Comment clean up
86
+ - Bug fixes that change default return values or error codes stored in constants
87
+ - Adding logging messages or debugging output
88
+ - Changes to 'metadata' files like Gemfile, .gitignore, build scripts, etc.
89
+ - Moving source files from one directory or package to another
90
+
91
+ **Whenever you invoke the "obvious fix" rule, please say so in your commit message:**
92
+
93
+ ```
94
+ ------------------------------------------------------------------------
95
+ commit 370adb3f82d55d912b0cf9c1d1e99b132a8ed3b5
96
+ Author: Julia Child <juliachild@chef.io>
97
+ Date: Wed Sep 18 11:44:40 2015 -0700
98
+
99
+ Fix typo in the README.
100
+
101
+ Obvious fix.
102
+
103
+ ------------------------------------------------------------------------
104
+ ```
105
+
106
+ ## <a name="issues"></a>Issue Tracking
107
+
108
+ Chef uses Github Issues to track issues with knife-ec2. Issues should be
109
+ submitted at https://github.com/chef/knife-ec2/issues/new.
110
+
111
+ In order to decrease the back and forth in issues, and to help us get to
112
+ the bottom of them quickly we use the below issue template. You can copy/paste
113
+ this template into the issue you are opening and edit it accordingly.
114
+
115
+ <a name="issuetemplate"></a>
116
+ ```
117
+ ### Environment: [Details about the environment such as the Operating System, Ruby release, etc...]
118
+
119
+ ### Scenario:
120
+ [What you are trying to achieve and you can't?]
121
+
122
+
123
+ ### Steps to Reproduce:
124
+ [If you are filing an issue what are the things we need to do in order to repro your problem?]
125
+
126
+
127
+ ### Expected Result:
128
+ [What are you expecting to happen as the consequence of above reproduction steps?]
129
+
130
+
131
+ ### Actual Result:
132
+ [What actually happens after the reproduction steps?]
133
+ ```
134
+
135
+ ## Using git
136
+
137
+ You can copy the knife-ec2 repository to your local workstation by running
138
+ `git clone git://github.com/chef/knife-ec2.git`.
139
+
140
+ For collaboration purposes, it is best if you create a GitHub account
141
+ and fork the repository to your own account. Once you do this you will
142
+ be able to push your changes to your GitHub repository for others to
143
+ see and use.
144
+
145
+ ### Branches and Commits
146
+
147
+ You should submit your patch as a git branch named after the Github
148
+ issue, such as GH-22. This is called a _topic branch_ and allows users
149
+ to associate a branch of code with the ticket.
150
+
151
+ It is a best practice to have your commit message have a _summary
152
+ line_ that includes the ticket number, followed by an empty line and
153
+ then a brief description of the commit. This also helps other
154
+ contributors understand the purpose of changes to the code.
155
+
156
+ ```text
157
+ [GH-22] - platform_family and style
158
+
159
+ * use platform_family for platform checking
160
+ * update notifies syntax to "resource_type[resource_name]" instead of
161
+ resources() lookup
162
+ * GH-692 - delete config files dropped off by packages in conf.d
163
+ * dropped debian 4 support because all other platforms have the same
164
+ values, and it is older than "old stable" debian release
165
+ ```
166
+
167
+ Remember that not all users use Chef in the same way or on the same
168
+ operating systems as you, so it is helpful to be clear about your use
169
+ case and change so they can understand it even when it doesn't apply
170
+ to them.
171
+
172
+ ### More information
173
+
174
+ Additional help with git is available on the [Community
175
+ Contributions](https://docs.chef.io/community_contributions.html#use-git)
176
+ page on the Chef Docs site.
177
+
178
+ ## Unit Tests
179
+
180
+ knife-ec2 is tested with rspec unit tests to ensure changes don't cause
181
+ regressions for other use cases. All non-trivial changes must include
182
+ additional unit tests.
183
+
184
+ To run the rspec tests run the following commands from the root of the
185
+ project:
186
+
187
+ bundle install
188
+ bundle exec rspec spec
189
+
190
+ **All tests must pass** before your contribution can be merged. Thus it's a good idea
191
+ to execute the tests without your change to be sure you understand how to run
192
+ them, as well as after to validate that you've avoided regressions.
193
+
194
+ ## Code Review
195
+
196
+ Chef Software regularly reviews code contributions and provides suggestions
197
+ for improvement in the code itself or the implementation.
198
+
199
+ ## Release Cycle
200
+
201
+ The versioning for Chef Software projects is X.Y.Z.
202
+
203
+ * X is a major release, which may not be fully compatible with prior
204
+ major releases
205
+ * Y is a minor release, which adds both new features and bug fixes
206
+ * Z is a patch release, which adds just bug fixes
207
+
208
+ ## Working with the community
209
+
210
+ These resources will help you learn more about Chef and connect to
211
+ other members of the Chef community:
212
+
213
+ * [Chef Community Guidelines](https://docs.chef.io/community_guidelines.html)
214
+ * [Chef Mailing List](https://discourse.chef.io/c/dev)
215
+ * #chef and #chef-hacking IRC channels on irc.freenode.net
216
+ * [Supermarket site](https://supermarket.chef.io/)
217
+ * [Chef Docs](http://docs.chef.io)
218
+ * Chef Software Chef [product page](https://www.chef.io/chef/)
219
+
220
+
221
+ ## Contribution Do's and Don't's
222
+
223
+ Please do include tests for your contribution. If you need help, ask on the
224
+ [chef-dev mailing list](https://discourse.chef.io/c/dev) or the [#chef-hacking
225
+ IRC channel](https://botbot.me/freenode/chef-hacking/). Please provide
226
+ evidence of testing your contribution if it isn't trivial so we don't have to
227
+ duplicate effort in testing.
228
+
229
+ Please do **not** modify the version number of the gem, Chef
230
+ will select the appropriate version based on the release cycle
231
+ information above.
232
+
233
+ Please do **not** update the `CHANGELOG.md` for a new version. Not all
234
+ changes may be merged and released in the same versions. Chef Software
235
+ will update the `CHANGELOG.md` when releasing a new version.
236
+
237
+ ## Further Resources
238
+
239
+ ### Fog
240
+
241
+ Knife-ec2 uses the Fog gem to interact with EC2's API. When there's a new
242
+ feature of EC2 that you'd like to utilize in knife-ec2 use cases, that feature
243
+ will probably be exposed by Fog. You can read about Fog
244
+ at its [project page](https://github.com/fog/fog).
245
+