knife-linode 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a6f47d35a254089494d5e4ca24827a0b696ea49a
-  data.tar.gz: eb559a699426fe378ee87dfb0597337b65506da5
+SHA256:
+  metadata.gz: 75329cddc1c5430f5f92a03ff35003c5d2603504c09e853d82033fa6e6086030
+  data.tar.gz: 17ce5e9fbadc035328d46866c6c95a72c642d2e06b7419a7de374f693e5cd404
 SHA512:
-  metadata.gz: da98f8d901d5f1b1e262c9659dc40fcb7ada91dd5e770f6d17140f2909624a7aaeceb17941e1a0d9edec6f79460978f59b04b9fe653d091a97df2180d7fea28a
-  data.tar.gz: ae95c2c4da167b25bd75a8f34203416fd8a6c9e81f28e46ae885eb0ab1f8d2dae99c4579525e85e5e98b47fcf0d7c4c6dab2b4f177b37951169fc042d8dfff9b
+  metadata.gz: 6d6eee210bc080fbffd8f29921f4f55338d730641fd3efcc0f9ac630ce5201a311e040402a9cda547efe2074cc6a15d8eabe4cf7759e82beb21fa17d1dbae407
+  data.tar.gz: b13aa6196a7b1cea1e4a1530104164a2564bb11a8bef79b97e5936cc4bedffa53dba0b7188fd0bded47e1d9e4b618b5c0e3a6a937f1733ac4ea3d5f2b21f6ebb

data/.expeditor/config.yml

@@ -0,0 +1,44 @@
+# Documentation available at https://expeditor.chef.io/docs/getting-started/
+---
+# Slack channel in Chef Software slack to send notifications about build failures, etc
+slack:
+  notify_channel: sustaining-notify
+
+# This publish is triggered by the `built_in:publish_rubygems` artifact_action.
+rubygems:
+  - knife-linode
+
+github:
+  # This deletes the GitHub PR branch after successfully merged into the release branch
+  delete_branch_on_merge: true
+  # The tag format to use (e.g. v1.0.0)
+  version_tag_format: "v{{version}}"
+  # allow bumping the minor release via label
+  minor_bump_labels:
+    - "Expeditor: Bump Version Minor"
+  # allow bumping the major release via label
+  major_bump_labels:
+    - "Expeditor: Bump Version Major"
+
+changelog:
+  rollup_header: Changes not yet released to rubygems.org
+
+# These actions are taken, in order they are specified, anytime a Pull Request is merged.
+merge_actions:
+  - built_in:bump_version:
+      ignore_labels:
+        - "Expeditor: Skip Version Bump"
+        - "Expeditor: Skip All"
+  - bash:.expeditor/update_version.sh:
+      only_if: built_in:bump_version
+  - built_in:update_changelog:
+      ignore_labels:
+        - "Expeditor: Skip Changelog"
+        - "Expeditor: Skip All"
+  - built_in:build_gem:
+      only_if: built_in:bump_version
+
+promote:
+  actions:
+    - built_in:rollover_changelog
+    - built_in:publish_rubygems

data/.expeditor/update_version.sh

@@ -0,0 +1,12 @@
+#!/bin/sh
+#
+# After a PR merge, Chef Expeditor will bump the PATCH version in the VERSION file.
+# It then executes this file to update any other files/components with that new version.
+#
+
+set -evx
+
+sed -i -r "s/^(\s*)VERSION = \".+\"/\1VERSION = \"$(cat VERSION)\"/" lib/knife-linode/version.rb
+
+# Once Expeditor finishes executing this script, it will commit the changes and push
+# the commit as a new tag corresponding to the value in the VERSION file.

data/.github/CODEOWNERS

@@ -0,0 +1,5 @@
+# Order is important. The last matching pattern has the most precedence.
+
+*                     @chef/msys-developers
+.expeditor/           @chef/jex-team
+*.md                  @chef/docs-team

data/.github/ISSUE_TEMPLATE/BUG_TEMPLATE.md

@@ -0,0 +1,29 @@
+---
+name: � Bug Report
+about: If something isn't working as expected �.
+labels: "Status: Untriaged"
+---
+
+# Version:
+
+[Version of the project installed]
+
+# Environment:
+
+[Details about the environment such as the Operating System, cookbook details, etc...]
+
+# Scenario:
+
+[What you are trying to achieve and you can't?]
+
+# Steps to Reproduce:
+
+[If you are filing an issue what are the things we need to do in order to repro your problem?]
+
+# Expected Result:
+
+[What are you expecting to happen as the consequence of above reproduction steps?]
+
+# Actual Result:
+
+[What actually happens after the reproduction steps?]

data/.github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md

@@ -0,0 +1,40 @@
+---
+name: Design Proposal
+about: I have a significant change I would like to propose and discuss before starting
+labels: "Status: Untriaged"
+---
+
+### When a Change Needs a Design Proposal
+
+A design proposal should be opened any time a change meets one of the following qualifications:
+
+- Significantly changes the user experience of a project in a way that impacts users.
+- Significantly changes the underlying architecture of the project in a way that impacts other developers.
+- Changes the development or testing process of the project such as a change of CI systems or test frameworks.
+
+### Why We Use This Process
+
+- Allows all interested parties (including any community member) to discuss large impact changes to a project.
+- Serves as a durable paper trail for discussions regarding project architecture.
+- Forces design discussions to occur before PRs are created.
+- Reduces PR refactoring and rejected PRs.
+
+---
+
+<!---  Proposal description and rationale.  -->
+
+## Motivation
+
+<!---
+    As a <<user_profile>>,
+    I want to <<functionality>>,
+    so that <<benefit>>.
+ -->
+
+## Specification
+
+<!---  A detailed description of the planned implementation. -->
+
+## Downstream Impact
+
+<!---  Which other tools will be impacted by this work?  -->

data/.github/ISSUE_TEMPLATE/ENHANCEMENT_REQUEST_TEMPLATE.md

@@ -0,0 +1,17 @@
+---
+name: 🚀 Enhancement Request
+about: I have a suggestion (and may want to implement it 🙂)!
+labels: "Status: Untriaged"
+---
+
+### Describe the Enhancement:
+<!---  What you are trying to achieve that you can't? -->
+
+### Describe the Need:
+<!---  What kind of user do you believe would utilize this enhancement, and how many users might want this functionality -->
+
+### Current Alternative
+<!--- Is there a current alternative that you can utilize to workaround the lack of this enhancement -->
+
+### Can We Help You Implement This?:
+<!---  The best way to ensure your enhancement is built is to help implement the enhancement yourself. If you're interested in helping out we'd love to give you a hand to make this possible. Let us know if there's something you need. -->

data/.github/ISSUE_TEMPLATE/SUPPORT_QUESTION.md

@@ -0,0 +1,12 @@
+---
+name: 🤗 Support Question
+about: If you have a question 💬, please check out our Slack!
+---
+
+We use GitHub issues to track bugs and feature requests. If you need help please post to our Mailing List or join the Chef Community Slack.
+
+ * Chef Community Slack at http://community-slack.chef.io/.
+ * Chef Mailing List https://discourse.chef.io/
+
+
+ Support issues opened here will be closed and redirected to Slack or Discourse.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,15 @@
+### Description
+
+[Please describe what this change achieves]
+
+### Issues Resolved
+
+[List any existing issues this PR resolves, or any Discourse or
+StackOverflow discussions that are relevant]
+
+### Check List
+
+- [ ] New functionality includes tests
+- [ ] All tests pass
+- [ ] All commits have been signed-off for the Developer Certificate of Origin. See <https://github.com/chef/chef/blob/master/CONTRIBUTING.md#developer-certification-of-origin-dco>
+- [ ] PR title is a worthy inclusion in the CHANGELOG

data/.github/lock.yml

@@ -0,0 +1 @@
+daysUntilLock: 60

data/.gitignore

@@ -1,3 +1,26 @@
-pkg/*
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+.swp
+.swo
 Gemfile.lock
-.rspec
+.rvmrc
+.ruby-version
+
+.direnv/
+.envrc

data/.rspec

@@ -0,0 +1,3 @@
+--color
+-fdocumentation
+

data/.rubocop.yml

@@ -0,0 +1,12 @@
+Lint/DuplicateCaseCondition:
+  Exclude:
+    - 'spec/chef/knife/linode_server_create_spec.rb'
+
+Lint/EmptyWhen:
+  Exclude:
+    - 'spec/chef/knife/linode_server_create_spec.rb'
+
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/chef/knife/linode_base.rb'
+    - 'lib/chef/knife/linode_stackscript_list.rb'

data/.travis.yml

@@ -1,5 +1,20 @@
-rvm:
-  - 2.0.0
-script:
-#  - bundle exec rubocop .
-  - bundle exec rspec --color --format progress
+sudo: false
+language: ruby
+cache: bundler
+
+matrix:
+  include:
+    - rvm: 2.3.7
+    - rvm: 2.4.4
+    - rvm: 2.5.1
+    - rvm: ruby-head
+  allow_failures:
+    - rvm: ruby-head
+
+branches:
+  only:
+  - master
+
+bundler_args: --without docs development
+
+script: bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# knife-linode Change Log
+
+<!-- latest_release -->
+<!-- latest_release -->
+
+<!-- release_rollup -->
+<!-- release_rollup -->
+
+<!-- latest_stable_release -->
+## [v0.3.3](https://github.com/chef/knife-linode/tree/v0.3.3) (2019-08-08)
+
+#### Merged Pull Requests
+- Update README.md for OSS Best Practices [#61](https://github.com/chef/knife-linode/pull/61) ([Vasu1105](https://github.com/Vasu1105))
+<!-- latest_stable_release -->
+

data/Gemfile

@@ -1,4 +1,30 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in knife-linode.gemspec
 gemspec
+
+group :docs do
+  gem "yard"
+  gem "redcarpet"
+  gem "github-markup"
+end
+
+group :test do
+  gem "chefstyle"
+  gem "rspec", "~> 3.1"
+  gem "rake"
+  gem "chef", ">= 12.0"
+end
+
+group :development do
+  gem "pry"
+  gem "pry-byebug"
+  gem "pry-stack_explorer"
+  gem "rb-readline"
+  gem "simplecov", "~> 0.9"
+end
+
+instance_eval(ENV["GEMFILE_MOD"]) if ENV["GEMFILE_MOD"]
+
+# If you want to load debugging tools into the bundle exec sandbox,
+# add these additional dependencies into Gemfile.local
+eval_gemfile(__FILE__ + ".local") if File.exist?(__FILE__ + ".local")

data/README.md

@@ -1,87 +1,81 @@
-## Knife Linode
+# Knife Linode
 
-### Description
+[![Gem Version](https://badge.fury.io/rb/knife-linode.svg)](https://rubygems.org/gems/knife-linode) [![Build Status](https://travis-ci.org/chef/knife-linode.svg?branch=master)](https://travis-ci.org/chef/knife-linode)
 
-This is the official Opscode Knife plugin for Linode. This plugin gives knife
-the ability to create, bootstrap, and manage Linode instances.
+* **Umbrella Project: [Knife](https://github.com/chef/chef-oss-practices/blob/master/projects/knife.md)**
 
-In-depth usage instructions can be found on the [Chef Docs](http://docs.opscode.com/plugin_knife_linode.html).
+* **Project State [Deprecated](https://github.com/chef/chef-oss-practices/blob/master/repo-management/repo-states.md#deprecated)**
 
-### Requirements
+* **Issues [Response Time Maximum](https://github.com/chef/chef-oss-practices/blob/master/repo-management/repo-states.md#what-is-the-response-time-maximum): None**
 
-* Chef 11.8.x or higher
-* Ruby 2.0.x or higher 
+* **Pull Request [Response Time Maximum](https://github.com/chef/chef-oss-practices/blob/master/repo-management/repo-states.md#what-is-the-response-time-maximum): None**
 
-### Installation
+## Description
 
-This plugin is distributed as a Ruby Gem. To install it, run:
+This is the official Chef Knife plugin for Linode. This plugin gives knife the ability to create, bootstrap, and manage Linode instances.
 
-    gem install knife-linode
+## Requirements
 
-Or use bundler:
+- Chef 12.0 higher
+- Ruby 2.2.2 or higher
 
-    gem 'knife-linode', '~> 0.3'
+## Installation
 
-Depending on your system's configuration, you may need to run this command
-with root privileges.
+Using [ChefDK](https://downloads.chef.io/chef-dk/), simply install the Gem:
 
-### Configuration
+```bash
+$ chef gem install knife-linode
+```
 
-In order to communicate with the Linode API you will have to tell Knife about
-your Linode API Key.  The easiest way to accomplish this is to create some
-entries in your `knife.rb` file:
+## Configuration
 
-    knife[:linode_api_key] = "Your Linode API Key"
+### knife.rb
 
-If your knife.rb file will be checked into a SCM system (ie readable by
-others) you may want to read the values from environment variables:
+In order to communicate with the Linode API you will have to tell Knife about your Linode API Key. The easiest way to accomplish this is to create some entries in your `knife.rb` file:
 
-    knife[:linode_api_key] = "#{ENV['LINODE_API_KEY']}"
+```ruby
+knife[:linode_api_key] = "Your Linode API Key"
+```
 
-You also have the option of passing your Linode API Key into the individual
-knife subcommands using the `-A` (or `--linode-api-key`) command option
+If your knife.rb file will be checked into a SCM system (ie readable by others) you may want to read the values from environment variables:
 
-    # Provision a new 1 GB 64 bit Ubuntu 14.04 Linode in the Dallas, TX datacenter
-    knife linode server create -r 'role[webserver]' --linode-image 124 --linode-datacenter 2 --linode-flavor 1 --linode-node-name YOUR_LINODE_NODE_NAME
+```ruby
+knife[:linode_api_key] = "#{ENV['LINODE_API_KEY']}"
+```
+
+You also have the option of passing your Linode API Key into the individual knife subcommands using the `-A` (or `--linode-api-key`) command option
+
+```
+# Provision a new 1 GB 64 bit Ubuntu 14.04 Linode in the Dallas, TX datacenter
+knife linode server create -r 'role[webserver]' --linode-image 124 --linode-datacenter 2 --linode-flavor 1 --linode-node-name YOUR_LINODE_NODE_NAME
+```
 
 Additionally the following options may be set in your `knife.rb`:
 
-*   linode_flavor
-*   linode_image
-*   linode_kernel
-*   ssh_password
-*   bootstrap_version
-*   distro
-*   template_file
+- linode_flavor
+- linode_image
+- linode_kernel
+- ssh_password
+- bootstrap_version
+- distro
+- template_file
 
-## Sub Commands
+## Knife Sub Commands
 
-This plugin provides the following Knife subcommands.  Specific command
-options can be found by invoking the subcommand with a `--help` flag
+This plugin provides the following Knife subcommands. Specific command options can be found by invoking the subcommand with a `--help` flag
 
 ### knife linode server create
 
-Provisions a new server in Linode and then perform a Chef bootstrap (using the
-SSH protocol).  The goal of the bootstrap is to get Chef installed on the
-target system so it can run Chef Client with a Chef Server. The main
-assumption is a baseline OS installation exists (provided by the
-provisioning). It is primarily intended for Chef Client systems that talk to a
-Chef server.  By default the server is bootstrapped using the
-[ubuntu10.04-gems](https://github.com/opscode/chef/blob/master/chef/lib/chef/k
-nife/bootstrap/ubuntu10.04-gems.erb) template.  This can be overridden using
-the `-d` or `--template-file` command options.
+Provisions a new server in Linode and then perform a Chef bootstrap (using the SSH protocol). The goal of the bootstrap is to get Chef installed on the target system so it can run Chef Client with a Chef Server. The main assumption is a baseline OS installation exists (provided by the provisioning). It is primarily intended for Chef Client systems that talk to a Chef server. By default the server is bootstrapped using the [ubuntu10.04-gems](https://github.com/opscode/chef/blob/master/chef/lib/chef/k
+nife/bootstrap/ubuntu10.04-gems.erb) template. This can be overridden using the `-d` or `--template-file` command options.
 
 ### knife linode server delete
 
-Deletes an existing server in the currently configured Linode account.
-**PLEASE NOTE** - this does not delete the associated node and client objects
-from the Chef server.
+Deletes an existing server in the currently configured Linode account. **PLEASE NOTE** - this does not delete the associated node and client objects from the Chef server.
 
 ### knife linode server list
 
-Outputs a list of all servers in the currently configured Linode account.
-**PLEASE NOTE** - this shows all instances associated with the account, some
-of which may not be currently managed by the Chef server.
+Outputs a list of all servers in the currently configured Linode account. **PLEASE NOTE** - this shows all instances associated with the account, some of which may not be currently managed by the Chef server.
 
 ### knife linode server reboot
 
@@ -93,13 +87,11 @@ View a list of available data centers, listed by data center ID and location.
 
 ### knife linode flavor list
 
-View a list of servers from the Linode environment, listed by ID, name, RAM,
-disk, and Price.
+View a list of servers from the Linode environment, listed by ID, name, RAM, disk, and Price.
 
 ### knife linode image list
 
-View a list of images from the Linode environment, listed by ID, name, bits,
-and image size.
+View a list of images from the Linode environment, listed by ID, name, bits, and image size.
 
 ### knife linode kernel list
 
@@ -109,27 +101,27 @@ View a a list of available kernels, listed by ID and name.
 
 View a list of Linode StackScripts that are currently being used.
 
-## License
+## Contributing
+
+For information on contributing to this project see <https://github.com/chef/chef/blob/master/CONTRIBUTING.md>
 
-Apache License, Version 2.0
+## License and Authors
 
-Original Author: Adam Jacob (<adam@opscode.com>)
+- Author:: Adam Jacob ([adam@chef.io](mailto:adam@chef.io))
+- Author:: Jesse Adams ([jesse@techno-geeks.org](mailto:jesse@techno-geeks.org))
 
-Copyright (c) 2009-2014 Opscode, Inc.
+```text
+Copyright 2009-2016 Chef Software, Inc.
 
-Licensed under the Apache License, Version 2.0 (the "License"); you may not
-use this file except in compliance with the License. You may obtain a copy of
-the License at
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
 
     http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-License for the specific language governing permissions and limitations under
-the License.
-
-## Maintainers
-
-* Jesse R. Adams ([jesseadams](https://github.com/jesseadams))
-* You?
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```