Document DropletKit deprecation in README and gemspec (#340)

* Document DropletKit deprecation in README and gemspec

Align the repository with the deprecated status on docs.digitalocean.com:
banner and deprecation section in README, updated contributing/release
guidance, gemspec metadata and post_install_message for a future release.

Co-authored-by: Cursor <cursoragent@cursor.com>

* Fix RuboCop offenses for CI

Correct gemspec string style, satisfy new Layout and Style cops in lib
and specs, and fix RSpec/LeakyLocalVariable by moving setup into examples.

Co-authored-by: Cursor <cursoragent@cursor.com>

* Revert unrelated RuboCop code changes; exclude cops in todo

Keep Class.new error definitions and existing spec layout. CI failures
were from new cops, not deprecation work — add exclusions instead.

Co-authored-by: Cursor <cursoragent@cursor.com>

---------

Co-authored-by: Cursor <cursoragent@cursor.com>

Author: kishlay-singh-DO

.rubocop_todo.yml

@@ -181,3 +181,28 @@ Style/SymbolProc:
 # URISchemes: http, https
 Layout/LineLength:
   Max: 221
+
+# Offense count: 4
+Style/EmptyClassDefinition:
+  Exclude:
+    - 'lib/droplet_kit.rb'
+
+# Offense count: 11
+Layout/EmptyLinesAfterModuleInclusion:
+  Exclude:
+    - 'lib/droplet_kit/mappings/container_registry_mapping.rb'
+    - 'lib/droplet_kit/mappings/container_registry_repository_mapping.rb'
+    - 'lib/droplet_kit/mappings/container_registry_repository_tag_mapping.rb'
+    - 'lib/droplet_kit/mappings/database_postgres_config_mapping.rb'
+    - 'lib/droplet_kit/mappings/kubernetes_cluster_mapping.rb'
+    - 'lib/droplet_kit/mappings/kubernetes_maintenance_policy_mapping.rb'
+    - 'lib/droplet_kit/mappings/kubernetes_node_mapping.rb'
+    - 'lib/droplet_kit/mappings/kubernetes_node_pool_mapping.rb'
+    - 'lib/droplet_kit/mappings/kubernetes_options_mapping.rb'
+    - 'lib/droplet_kit/resources/kubernetes_options_resource.rb'
+
+# Offense count: 4
+RSpec/LeakyLocalVariable:
+  Exclude:
+    - 'spec/lib/droplet_kit/resources/database_resource_spec.rb'
+    - 'spec/lib/droplet_kit/resources/droplet_resource_spec.rb'

CHANGELOG.md

@@ -1,3 +1,7 @@
+## Unreleased
+
+- Document repository deprecation in README, gemspec metadata, and [RELEASE.md](RELEASE.md).
+
 ## Version 3.22.0
 
 - #332 - @vnegi-digitalocean - add reserved ipv6 support

README.md

@@ -1,8 +1,18 @@
 # DropletKit
+
+> **Deprecated:** DropletKit is no longer actively maintained. New applications should use the [DigitalOcean API](https://docs.digitalocean.com/reference/api/) directly or a [supported SDK](https://docs.digitalocean.com/reference/libraries/) (TypeScript, Go, or Python). There is no official Ruby SDK.
+
 [![Build Status](https://github.com/digitalocean/droplet_kit/workflows/CI/badge.svg?branch=main)](https://github.com/digitalocean/droplet_kit/actions)
 [![Gem Version](https://badge.fury.io/rb/droplet_kit.svg)](https://badge.fury.io/rb/droplet_kit)
 
-DropletKit is the official [DigitalOcean V2 API](https://developers.digitalocean.com/v2/) client. It supports everything the API can do with a simple interface written in Ruby.
+DropletKit is a Ruby client for the [DigitalOcean V2 API](https://developers.digitalocean.com/v2/). It provides resource-oriented access to API endpoints. Existing apps may continue to use published gem versions; new API features will not be added here.
+
+## Deprecation
+
+- **Status:** Deprecated; no new features or API coverage. Critical security fixes only.
+- **RubyGems:** Published versions remain available; no new releases are planned.
+- **Migration:** Call the [API reference](https://docs.digitalocean.com/reference/api/) directly, or use [Godo](https://github.com/digitalocean/godo), [PyDo](https://github.com/digitalocean/pydo), or [DoTs](https://github.com/digitalocean/dots) from another language or service.
+- **Forks:** Permitted under the [MIT license](LICENSE.txt).
 
 ## Installation
 
@@ -725,11 +735,8 @@ Actions supported:
 
 ## Contributing
 
-1. Fork it ( https://github.com/digitalocean/droplet_kit/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+This repository is deprecated and not accepting new features or API endpoint coverage. Critical security fixes may be considered on a case-by-case basis; open an issue before submitting a pull request.
 
 ## Releasing
-See [RELEASE](RELEASE.md) for details
+
+New gem releases are not planned. See [RELEASE](RELEASE.md) for the historical release process.

RELEASE.md

@@ -1,19 +1,21 @@
-## Releasing
+# Releasing
 
-Once the changes have been merged to main it's time to release a new
-version of the gem.
+> **Note:** DropletKit is deprecated (see [README](README.md)). **No new gem releases are planned.** This document is kept for maintainers handling historical releases or a final deprecation notice release.
 
-1. Creating a PR with a semantic version bump to
-[version](https://github.com/digitalocean/droplet_kit/blob/main/lib/droplet_kit/version.rb)
-and all the changes being released added to the
-[CHANGELOG](https://github.com/digitalocean/droplet_kit/blob/main/CHANGELOG.md).
-1. After the PR has been merged, create a release on GitHub for the new version:
-    - The tag should be in the format of: vX.Y.Z
-        - You can think of X.Y.Z as such:
-            X = breaking
-            Y = feature
-            Z = bugfix
-    - The title should be in the format of: vX.Y.Z (same as tag)
-    - The description should include all the changes being released in the format of:
-        - #[PR #] - @[contributor] - [description]
-1. When the tag is created, a GitHub Actions workflow will publish the release to rubygems.
+## Historical process
+
+Once changes were merged to `main`, a new gem version was released as follows:
+
+1. Create a PR with a semantic version bump to
+   [version](https://github.com/digitalocean/droplet_kit/blob/main/lib/droplet_kit/version.rb)
+   and all changes being released added to the
+   [CHANGELOG](https://github.com/digitalocean/droplet_kit/blob/main/CHANGELOG.md).
+2. After the PR was merged, create a release on GitHub for the new version:
+   - Tag format: `vX.Y.Z`
+   - Version semantics: `X` = breaking, `Y` = feature, `Z` = bugfix
+   - Release description: `#[PR #] - @[contributor] - [description]`
+3. When the tag was created, a GitHub Actions workflow published the release to RubyGems.
+
+## Deprecation
+
+If a final gem release is published to surface the `post_install_message` in `droplet_kit.gemspec`, follow the steps above with a patch version bump and a CHANGELOG entry documenting the deprecation notice.

droplet_kit.gemspec

@@ -9,8 +9,14 @@ Gem::Specification.new do |spec|
   spec.version       = DropletKit::VERSION
   spec.authors       = ['DigitalOcean API Engineering team']
   spec.email         = ['api-engineering@digitalocean.com']
-  spec.summary       = "Droplet Kit is the official Ruby library for DigitalOcean's API"
-  spec.description   = "Droplet Kit is the official Ruby library for DigitalOcean's API"
+  spec.summary       = '[DEPRECATED] Ruby client for the DigitalOcean API v2'
+  spec.description   = 'DropletKit is deprecated and no longer actively maintained. See https://github.com/digitalocean/droplet_kit and https://docs.digitalocean.com/reference/libraries/'
+  spec.post_install_message = <<~MSG
+
+    DropletKit is deprecated and no longer actively maintained by DigitalOcean.
+    See https://docs.digitalocean.com/reference/libraries/ for supported SDKs.
+
+  MSG
   spec.homepage      = 'https://github.com/digitalocean/droplet_kit'
   spec.license       = 'MIT'