cpl 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 711286ef49686f6c51df2a94c533b3df94f4d71d3fb6018b6ed61c210593dd47
-  data.tar.gz: '085357faac6b5b27e493049b34c27debab21fa19950af21548fe11889140b557'
+  metadata.gz: d76f46cb9427fc137ece07123d0ddd0d1add98e1ffa046a95e1394916784676e
+  data.tar.gz: 266681f356c78d8a4636ae27cb90485a49eda80c27a6199bd3505ddd72cd3451
 SHA512:
-  metadata.gz: ac229234f4919d8e1b3485095476ef0fddac04573d8dd03aba6a3737fd5e90b319538e04c51d98e5f33f244fe304c519d949a624a377bbc9ee9067754a0c71dd
-  data.tar.gz: 0ba5203d4f8539dde89a2eb5a52dc92c2098d11bb1914002cd57628081465d08e9842f47546da563bc18edda17fbf12101bfefca8fdcee4088825c0e56ee0fa0
+  metadata.gz: 33f9ec2f7af612611d3a55114097f21a2a2cc9605b3bd2813345b9a06f8308a28d204bd71f49f96e2d1a77798e920621651e457801d795b40f3bf51abe91e985
+  data.tar.gz: d2c82fb6b24cf54e306e83f21b0c8a1b519147e1f8ec66b81442b2ae05f2c752eb18c60cb94c66c2cd11ea921db228116b2bc3ead49c77f1317ce0aa4e290ff1

data/.github/workflows/check_cpln_links.yml

@@ -0,0 +1,19 @@
+name: Check Links
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  check_cpln_links:
+    runs-on: ubuntu-latest
+    name: Check Links
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Validate outgoing links to Control Plane
+        run: |
+          TERM=xterm-color ./script/check_cpln_links
+        shell: bash

data/.overcommit.yml

@@ -1,4 +1,7 @@
 PreCommit:
+  ValidateLinks:
+    enabled: true
+    command: ["bash", "./script/check_cpln_links"]
   CommandDocs:
     enabled: true
     command: ["bundle", "exec", "rake", "check_command_docs"]

data/CHANGELOG.md

@@ -16,6 +16,28 @@ _Please add entries here for your pull requests that are not yet released._
 
 ### Fixed
 
+- Fixed issue where cpln profile was not switched back to `default` if an error happened while running `copy-image-from-upstream` command. [PR 135](https://github.com/shakacode/heroku-to-control-plane/pull/135) by [Rafael Gomes](https://github.com/rafaelgomesxyz).
+- Fixed issue that didn't allow using upstream with `match_if_app_name_starts_with` set to `true` in `copy-image-from-upstream` command. [PR 136](https://github.com/shakacode/heroku-to-control-plane/pull/136) by [Rafael Gomes](https://github.com/rafaelgomesxyz).
+
+### Added
+
+- Added `--no-clean-on-failure` option to `run:detached` command to skip deletion of failed workload run. [PR 133](https://github.com/shakacode/heroku-to-control-plane/pull/133) by [Justin Gordon](https://github.com/justin808) and [Rafael Gomes](https://github.com/rafaelgomesxyz).
+- Added `--domain` option to `maintenance`, `maintenance:on` and `maintenance:off` commands. [PR 131](https://github.com/shakacode/heroku-to-control-plane/pull/131) by [Rafael Gomes](https://github.com/rafaelgomesxyz).
+- Added `default_domain` config to specify domain for `maintenance`, `maintenance:on` and `maintenance:off` commands. [PR 131](https://github.com/shakacode/heroku-to-control-plane/pull/131) by [Rafael Gomes](https://github.com/rafaelgomesxyz).
+- Added option to specify upstream for `copy-image-from-upstream` command through `CPLN_UPSTREAM` env var. [PR 138](https://github.com/shakacode/heroku-to-control-plane/pull/138) by [Rafael Gomes](https://github.com/rafaelgomesxyz).
+
+### Changed
+
+- `build-image` command now accepts extra options and passes them to `docker build`. [PR 126](https://github.com/shakacode/heroku-to-control-plane/pull/126) by [Rafael Gomes](https://github.com/rafaelgomesxyz).
+- `CPLN_ORG_UPSTREAM` env var now takes precedence over config from `controlplane.yml` in `copy-image-from-upstream` command. [PR 137](https://github.com/shakacode/heroku-to-control-plane/pull/137) by [Rafael Gomes](https://github.com/rafaelgomesxyz).
+- `info` command now works properly for apps with `match_if_app_name_starts_with` set to `true`.[PR 139](https://github.com/shakacode/heroku-to-control-plane/pull/139) by [Rafael Gomes](https://github.com/rafaelgomesxyz).
+- `info` command now lists workloads in the same order as `controlplane.yml`. [PR 139](https://github.com/shakacode/heroku-to-control-plane/pull/139) by [Rafael Gomes](https://github.com/rafaelgomesxyz).
+- Improved domain workload matching for `maintenance`, `maintenance:on` and `maintenance:off` commands (instead of matching only by workload, it now matches by org + app + workload, which is more accurate). [PR 140](https://github.com/shakacode/heroku-to-control-plane/pull/140) by [Rafael Gomes](https://github.com/rafaelgomesxyz).
+
+## [1.2.0] - 2024-01-03
+
+### Fixed
+
 - Fixed issue where `info` command does not respect `CPLN_ORG` env var. [PR 88](https://github.com/shakacode/heroku-to-control-plane/pull/88) by [Rafael Gomes](https://github.com/rafaelgomesxyz).
 - Fixed issues with running `cpl --version` and `cpl --help` where no configuration file exists. [PR 100](https://github.com/shakacode/heroku-to-control-plane/pull/100) by [Mostafa Ahangarha](https://github.com/ahangarha).
 - Fixed issue where `delete` command fails to delete apps with volumesets. [PR 123](https://github.com/shakacode/heroku-to-control-plane/pull/123) by [Rafael Gomes](https://github.com/rafaelgomesxyz).
@@ -117,7 +139,8 @@ _Please add entries here for your pull requests that are not yet released._
 
 - Initial release
 
-[Unreleased]: https://github.com/shakacode/heroku-to-control-plane/compare/v1.1.2...HEAD
+[Unreleased]: https://github.com/shakacode/heroku-to-control-plane/compare/v1.2.0...HEAD
+[1.2.0]: https://github.com/shakacode/heroku-to-control-plane/compare/v1.1.2...v1.2.0
 [1.1.2]: https://github.com/shakacode/heroku-to-control-plane/compare/v1.1.1...v1.1.2
 [1.1.1]: https://github.com/shakacode/heroku-to-control-plane/compare/v1.1.0...v1.1.1
 [1.1.0]: https://github.com/shakacode/heroku-to-control-plane/compare/v1.0.4...v1.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cpl (1.2.0)
+    cpl (1.3.0)
       debug (~> 1.7.1)
       dotenv (~> 2.8.1)
       psych (~> 5.1.0)
@@ -24,10 +24,10 @@ GEM
     dotenv (2.8.1)
     hashdiff (1.0.1)
     iniparse (1.5.0)
-    io-console (0.7.1)
-    irb (1.11.0)
+    io-console (0.7.2)
+    irb (1.12.0)
       rdoc
-      reline (>= 0.3.8)
+      reline (>= 0.4.2)
     json (2.6.3)
     overcommit (0.60.0)
       childprocess (>= 0.6.3, < 5)
@@ -44,7 +44,7 @@ GEM
     rdoc (6.6.2)
       psych (>= 4.0.0)
     regexp_parser (2.6.2)
-    reline (0.4.1)
+    reline (0.4.3)
       io-console (~> 0.5)
     rexml (3.2.5)
     rspec (3.12.0)

data/README.md

@@ -1,4 +1,4 @@
-# Heroku to Control Plane `cpl` CLI
+# The power of Kubernetes with the ease of Heroku!
 
 <meta name="author" content="Justin Gordon and Sergey Tarasov">
 <meta name="description" content="Instructions on how to migrate from Heroku to Control Plane and a CLI called cpl to make it easier.">
@@ -6,16 +6,24 @@
 <meta name="keywords" content="Control Plane, Heroku, Kubernetes, K8, Infrastructure">
 <meta name="google-site-verification" content="dIV4nMplcYl6YOKOaZMqgvdKXhLJ4cdYY6pS6e_YrPU" />
 
-_A gem that provides **Heroku Flow** functionality on Control Plane, including docs for migrating from [Heroku](https://heroku.com) to [Control Plane](https://shakacode.controlplane.com/)._
-
 [![RSpec](https://github.com/shakacode/heroku-to-control-plane/actions/workflows/rspec.yml/badge.svg)](https://github.com/shakacode/heroku-to-control-plane/actions/workflows/rspec.yml)
 [![Rubocop](https://github.com/shakacode/heroku-to-control-plane/actions/workflows/rubocop.yml/badge.svg)](https://github.com/shakacode/heroku-to-control-plane/actions/workflows/rubocop.yml)
 
 [![Gem](https://badge.fury.io/rb/cpl.svg)](https://badge.fury.io/rb/cpl)
 
+
+Here's a playbook for migrating from [Heroku Flow](https://www.heroku.com/flow) to [Control Plane](https://shakacode.controlplane.com) with our `cpl` gem source code.
+
+----
+
+_If you need a free demo account for Control Plane (no CC required), you can contact [Justin Gordon, CEO of ShakaCode](mailto:justin@shakacode.com)._
+
 ---
 
-_If you need a free demo account for Control Plane (no CC required), you can contact [controlplane@shakacode.com](mailto:controlplane@shakacode.com)._
+Be sure to see the [demo app](https://github.com/shakacode/react-webpack-rails-tutorial/tree/master/.controlplane)
+If you would like to see the simple YAML configuration and setup,
+Also, check [how the `cpl` gem (this project) is used in the Github actions](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/.github/actions/deploy-to-control-plane/action.yml).
+Here is a brief [video overview](https://www.youtube.com/watch?v=llaQoAV_6Iw).
 
 ---
 
@@ -117,7 +125,7 @@ npm update -g @controlplane/cli
 
 5. Run `cpln image docker-login --org <your-org>` to ensure that you have access to the Control Plane Docker registry.
 
-6. Install Heroku to Control Plane `cpl` CLI as a [Ruby gem](https://rubygems.org/gems/cpl): `gem install cpl`. If you want to hack on the source code, see [CONTRIBUTING.md](CONTRIBUTING.md). 
+6. Install Heroku to Control Plane `cpl` CLI as a [Ruby gem](https://rubygems.org/gems/cpl): `gem install cpl`. If you want to hack on the source code, see [CONTRIBUTING.md](CONTRIBUTING.md).
 
 7. You can use [this Dockerfile](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/.controlplane/Dockerfile) as an example for your project. Ensure that you have Docker running.
 
@@ -258,6 +266,10 @@ apps:
     # This is relative to the `.controlplane/` directory.
     release_script: release_script
 
+    # default_domain is used for commands that require a domain
+    # including `maintenance`, `maintenance:on`, `maintenance:off`.
+    default_domain: domain.com
+
   my-app-other:
     <<: *common
 
@@ -475,6 +487,13 @@ cpl --help
 
 ## Examples
 
-- See the `examples/` and `templates/` directories of this repository.
+- See this repository's `examples/` and `templates/` directories.
 - See the `.controlplane/` directory of this live example:
-  [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/tree/master/.controlplane)
+  [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/tree/master/.controlplane).
+- See [how the `cpl` gem is used in the Github actions](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/.github/actions/deploy-to-control-plane/action.yml).
+- Here is a brief [video overview](https://www.youtube.com/watch?v=llaQoAV_6Iw).
+
+## Resources
+* If you need a free demo account for Control Plane (no CC required), you can contact [Justin Gordon, CEO of ShakaCode](mailto:justin@shakacode.com).
+* [Control Plane Site](https://shakacode.controlplane.com)
+* [Join our Slack to Discuss Heroku to Control Plane](https://reactrails.slack.com/join/shared_invite/enQtNjY3NTczMjczNzYxLTlmYjdiZmY3MTVlMzU2YWE0OWM0MzNiZDI0MzdkZGFiZTFkYTFkOGVjODBmOWEyYWQ3MzA2NGE1YWJjNmVlMGE)

data/docs/commands.md

@@ -41,6 +41,7 @@ cpl apply-template gvc postgres redis rails -a $APP_NAME
 - Automatically assigns image numbers, e.g., `app:1`, `app:2`, etc.
 - Uses `.controlplane/Dockerfile` or a different Dockerfile specified through `dockerfile` in the `.controlplane/controlplane.yml` file
 - If a commit is provided through `--commit` or `-c`, it will be set as the runtime env var `GIT_COMMIT`
+- Accepts extra options that are passed to `docker build`
 
 ```sh
 cpl build-image -a $APP_NAME
@@ -86,7 +87,7 @@ cpl config -a $APP_NAME
 ### `copy-image-from-upstream`
 
 - Copies an image (by default the latest) from a source org to the current org
-- The source org must be specified through `upstream` in the `.controlplane/controlplane.yml` file
+- The source app must be specified either through the `CPLN_UPSTREAM` env var or `upstream` in the `.controlplane/controlplane.yml` file
 - Additionally, the token for the source org must be provided through `--upstream-token` or `-t`
 - A `cpln` profile will be temporarily created to pull the image from the source org
 
@@ -331,28 +332,25 @@ cpl ps:swait -a $APP_NAME -w $WORKLOAD_NAME
 cpl run -a $APP_NAME
 
 # Need to quote COMMAND if setting ENV value or passing args.
-cpl run 'LOG_LEVEL=warn rails db:migrate' -a $APP_NAME
-
-# COMMAND may also be passed at the end.
 cpl run -a $APP_NAME -- 'LOG_LEVEL=warn rails db:migrate'
 
 # Runs command, displays output, and exits shell.
-cpl run ls / -a $APP_NAME
-cpl run rails db:migrate:status -a $APP_NAME
+cpl run -a $APP_NAME -- ls /
+cpl run -a $APP_NAME -- rails db:migrate:status
 
 # Runs command and keeps shell open.
-cpl run rails c -a $APP_NAME
+cpl run -a $APP_NAME -- rails c
 
 # Uses a different image (which may not be promoted yet).
-cpl run rails db:migrate -a $APP_NAME --image appimage:123 # Exact image name
-cpl run rails db:migrate -a $APP_NAME --image latest       # Latest sequential image
+cpl run -a $APP_NAME --image appimage:123 -- rails db:migrate # Exact image name
+cpl run -a $APP_NAME --image latest -- rails db:migrate       # Latest sequential image
 
 # Uses a different workload than `one_off_workload` from `.controlplane/controlplane.yml`.
-cpl run bash -a $APP_NAME -w other-workload
+cpl run -a $APP_NAME -w other-workload -- bash
 
 # Overrides remote CPLN_TOKEN env variable with local token.
 # Useful when superuser rights are needed in remote container.
-cpl run bash -a $APP_NAME --use-local-token
+cpl run -a $APP_NAME --use-local-token -- bash
 ```
 
 ### `run:cleanup`
@@ -374,26 +372,26 @@ cpl run:cleanup -a $APP_NAME
 - Implemented with only async execution methods, more suitable for production tasks
 - Has alternative log fetch implementation with only JSON-polling and no WebSockets
 - Less responsive but more stable, useful for CI tasks
+- Deletes the workload whenever finished with success
+- Deletes the workload whenever finished with failure by default
+- Use `--no-clean-on-failure` to disable cleanup to help with debugging failed runs
 
 ```sh
 cpl run:detached rails db:prepare -a $APP_NAME
 
 # Need to quote COMMAND if setting ENV value or passing args.
-cpl run:detached 'LOG_LEVEL=warn rails db:migrate' -a $APP_NAME
-
-# COMMAND may also be passed at the end.
 cpl run:detached -a $APP_NAME -- 'LOG_LEVEL=warn rails db:migrate'
 
 # Uses a different image (which may not be promoted yet).
-cpl run:detached rails db:migrate -a $APP_NAME --image appimage:123 # Exact image name
-cpl run:detached rails db:migrate -a $APP_NAME --image latest       # Latest sequential image
+cpl run:detached -a $APP_NAME --image appimage:123 -- rails db:migrate # Exact image name
+cpl run:detached -a $APP_NAME --image latest -- rails db:migrate       # Latest sequential image
 
 # Uses a different workload than `one_off_workload` from `.controlplane/controlplane.yml`.
-cpl run:detached rails db:migrate:status -a $APP_NAME -w other-workload
+cpl run:detached -a $APP_NAME -w other-workload -- rails db:migrate:status
 
 # Overrides remote CPLN_TOKEN env variable with local token.
 # Useful when superuser rights are needed in remote container.
-cpl run:detached rails db:migrate:status -a $APP_NAME --use-local-token
+cpl run:detached -a $APP_NAME --use-local-token -- rails db:migrate:status
 ```
 
 ### `setup-app`

data/docs/dns.md

@@ -0,0 +1,9 @@
+# DNS Setup Example
+
+About reactrails.com DNS, steps:
+1. create CNAME or ALIAS record pointing to rails-xxxx.cpln.app
+1. go to CPLN Domains -> create
+1. add reactrails.com copy code from there
+1. add TXT record with code as _cpln.reactrails.com
+1. hit ok on CPLN, route to rails workload when asked
+1. wait domain check and certificates created

data/examples/controlplane.yml

@@ -101,6 +101,10 @@ apps:
     # This is relative to the `.controlplane/` directory.
     release_script: release_script
 
+    # default_domain is used for commands that require a domain
+    # including `maintenance`, `maintenance:on`, `maintenance:off`.
+    default_domain: domain.com
+
   my-app-other:
     <<: *common
 

data/lib/command/base.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
+require_relative "../core/helpers"
+
 module Command
   class Base # rubocop:disable Metrics/ClassLength
     attr_reader :config
 
+    include Helpers
+
     # Used to call the command (`cpl NAME`)
     # NAME = ""
     # Displayed when running `cpl help` or `cpl help NAME` (defaults to `NAME`)
@@ -15,6 +19,9 @@ module Command
     DEFAULT_ARGS = [].freeze
     # Options for the command (use option methods below)
     OPTIONS = [].freeze
+    # Does not throw error if `true` and extra options
+    # that are not specified in `OPTIONS` are passed to the command
+    ACCEPTS_EXTRA_OPTIONS = false
     # Displayed when running `cpl help`
     # DESCRIPTION = ""
     # Displayed when running `cpl help NAME`
@@ -122,6 +129,18 @@ module Command
       }
     end
 
+    def self.domain_option(required: false)
+      {
+        name: :domain,
+        params: {
+          banner: "DOMAIN_NAME",
+          desc: "Domain name",
+          type: :string,
+          required: required
+        }
+      }
+    end
+
     def self.upstream_token_option(required: false)
       {
         name: :upstream_token,
@@ -218,6 +237,18 @@ module Command
       }
     end
 
+    def self.clean_on_failure_option(required: false)
+      {
+        name: :clean_on_failure,
+        params: {
+          desc: "Deletes workload when finished with failure (success always deletes)",
+          type: :boolean,
+          required: required,
+          default: true
+        }
+      }
+    end
+
     def self.all_options
       methods.grep(/_option$/).map { |method| send(method.to_s) }
     end

data/lib/command/build_image.rb

@@ -7,12 +7,14 @@ module Command
       app_option(required: true),
       commit_option
     ].freeze
+    ACCEPTS_EXTRA_OPTIONS = true
     DESCRIPTION = "Builds and pushes the image to Control Plane"
     LONG_DESCRIPTION = <<~DESC
       - Builds and pushes the image to Control Plane
       - Automatically assigns image numbers, e.g., `app:1`, `app:2`, etc.
       - Uses `.controlplane/Dockerfile` or a different Dockerfile specified through `dockerfile` in the `.controlplane/controlplane.yml` file
       - If a commit is provided through `--commit` or `-c`, it will be set as the runtime env var `GIT_COMMIT`
+      - Accepts extra options that are passed to `docker build`
     DESC
 
     def call # rubocop:disable Metrics/MethodLength
@@ -32,7 +34,9 @@ module Command
       build_args = []
       build_args.push("GIT_COMMIT=#{commit}") if commit
 
-      cp.image_build(image_url, dockerfile: dockerfile, build_args: build_args)
+      cp.image_build(image_url, dockerfile: dockerfile,
+                                docker_args: config.args,
+                                build_args: build_args)
 
       progress.puts("\nPushed image to '/org/#{config.org}/image/#{image_name}'.")
     end

data/lib/command/copy_image_from_upstream.rb

@@ -11,7 +11,7 @@ module Command
     DESCRIPTION = "Copies an image (by default the latest) from a source org to the current org"
     LONG_DESCRIPTION = <<~DESC
       - Copies an image (by default the latest) from a source org to the current org
-      - The source org must be specified through `upstream` in the `.controlplane/controlplane.yml` file
+      - The source app must be specified either through the `CPLN_UPSTREAM` env var or `upstream` in the `.controlplane/controlplane.yml` file
       - Additionally, the token for the source org must be provided through `--upstream-token` or `-t`
       - A `cpln` profile will be temporarily created to pull the image from the source org
     DESC
@@ -28,8 +28,8 @@ module Command
     def call # rubocop:disable Metrics/MethodLength
       ensure_docker_running!
 
-      @upstream = config[:upstream]
-      @upstream_org = config.apps[@upstream.to_sym][:cpln_org] || ENV.fetch("CPLN_ORG_UPSTREAM", nil)
+      @upstream = ENV.fetch("CPLN_UPSTREAM", nil) || config[:upstream]
+      @upstream_org = ENV.fetch("CPLN_ORG_UPSTREAM", nil) || config.find_app_config(@upstream)&.dig(:cpln_org)
       ensure_upstream_org!
 
       create_upstream_profile
@@ -38,6 +38,7 @@ module Command
       pull_image_from_upstream
       push_image_to_app
     ensure
+      cp.profile_switch("default")
       delete_upstream_profile
     end
 
@@ -60,7 +61,7 @@ module Command
     def create_upstream_profile
       step("Creating upstream profile") do
         loop do
-          @upstream_profile = "upstream-#{rand(1000..9999)}"
+          @upstream_profile = "upstream-#{random_four_digits}"
           break unless cp.profile_exists?(@upstream_profile)
         end
 

data/lib/command/info.rb

@@ -32,7 +32,7 @@ module Command
       @missing_apps_workloads = {}
       @missing_apps_starting_with = {}
 
-      if config.app && !config.current[:match_if_app_name_starts_with]
+      if config.app && !config.should_app_start_with?(config.app)
         single_app_info
       else
         multiple_apps_info
@@ -41,20 +41,8 @@ module Command
 
     private
 
-    def app_matches?(app, app_name, app_options)
-      app == app_name.to_s || (app_options[:match_if_app_name_starts_with] && app.start_with?(app_name.to_s))
-    end
-
-    def find_app_options(app)
-      @app_options ||= {}
-      @app_options[app] ||= config.apps.find do |app_name, app_options|
-                              app_matches?(app, app_name, app_options)
-                            end&.last
-    end
-
     def find_workloads(app)
-      app_options = find_app_options(app)
-      return [] if app_options.nil?
+      app_options = config.find_app_config(app)
 
       (app_options[:app_workloads] + app_options[:additional_workloads] + [app_options[:one_off_workload]]).uniq
     end
@@ -75,21 +63,19 @@ module Command
       end
 
       if config.app
-        result.select { |app, _| app_matches?(app, config.app, config.current) }
+        result.select { |app, _| config.app_matches?(app, config.app, config.current) }
       else
-        result.reject { |app, _| find_app_options(app).nil? }
+        result.reject { |app, _| config.find_app_config(app).nil? }
       end
     end
 
-    def orgs # rubocop:disable Metrics/MethodLength
+    def orgs
       result = []
 
       if config.org
         result.push(config.org)
       else
-        config.apps.each do |app_name, app_options|
-          next if config.app && !app_matches?(config.app, app_name, app_options)
-
+        config.apps.each do |_, app_options|
           org = app_options[:cpln_org]
           result.push(org) if org && !result.include?(org)
         end
@@ -102,7 +88,7 @@ module Command
       result = []
 
       config.apps.each do |app_name, app_options|
-        next if config.app && !app_matches?(config.app, app_name, app_options)
+        next if config.app && !config.app_matches?(config.app, app_name, app_options)
 
         app_org = app_options[:cpln_org]
         result.push(app_name.to_s) if app_org == org
@@ -113,7 +99,7 @@ module Command
     end
 
     def any_app_starts_with?(app)
-      @app_workloads.keys.find { |app_name| app_matches?(app_name, app, config.apps[app.to_sym]) }
+      @app_workloads.keys.find { |app_name| config.app_matches?(app_name, app, config.apps[app.to_sym]) }
     end
 
     def check_any_app_starts_with(app)
@@ -184,8 +170,7 @@ module Command
            "(replace 'whatever' with whatever suffix you want):"
 
       @missing_apps_starting_with.each do |app, _workloads|
-        app_with_suffix = "#{app}#{app.end_with?('-') ? '' : '-'}whatever"
-        puts "  - `cpl setup-app -a #{app_with_suffix}`"
+        puts "  - `cpl setup-app -a #{app}-whatever`"
       end
     end
 
@@ -197,7 +182,7 @@ module Command
       @defined_workloads = find_workloads(config.app)
       @available_workloads = fetch_workloads(config.app)
 
-      workloads = (@defined_workloads + @available_workloads).uniq.sort
+      workloads = (@defined_workloads + @available_workloads).uniq
       workloads.each do |workload|
         print_workload(config.app, workload)
       end
@@ -217,7 +202,7 @@ module Command
           @defined_workloads = find_workloads(app)
           @available_workloads = @app_workloads[app] || []
 
-          workloads = (@defined_workloads + @available_workloads).uniq.sort
+          workloads = (@defined_workloads + @available_workloads).uniq
           workloads.each do |workload|
             print_workload(app, workload)
           end

data/lib/command/maintenance.rb

@@ -4,7 +4,8 @@ module Command
   class Maintenance < Base
     NAME = "maintenance"
     OPTIONS = [
-      app_option(required: true)
+      app_option(required: true),
+      domain_option
     ].freeze
     DESCRIPTION = "Checks if maintenance mode is on or off for an app"
     LONG_DESCRIPTION = <<~DESC
@@ -20,15 +21,18 @@ module Command
       one_off_workload = config[:one_off_workload]
       maintenance_workload = config.current[:maintenance_workload] || "maintenance"
 
-      domain_data = cp.find_domain_for([one_off_workload, maintenance_workload])
+      domain_data = if config.domain
+                      cp.fetch_domain(config.domain)
+                    else
+                      cp.find_domain_for([one_off_workload, maintenance_workload])
+                    end
       unless domain_data
         raise "Can't find domain. " \
               "Maintenance mode is only supported for domains that use path based routing mode " \
               "and have a route configured for the prefix '/' on either port 80 or 443."
       end
 
-      domain_workload = cp.get_domain_workload(domain_data)
-      if domain_workload == maintenance_workload
+      if cp.domain_workload_matches?(domain_data, maintenance_workload)
         puts "on"
       else
         puts "off"

data/lib/command/maintenance_off.rb

@@ -4,7 +4,8 @@ module Command
   class MaintenanceOff < Base
     NAME = "maintenance:off"
     OPTIONS = [
-      app_option(required: true)
+      app_option(required: true),
+      domain_option
     ].freeze
     DESCRIPTION = "Disables maintenance mode for an app"
     LONG_DESCRIPTION = <<~DESC
@@ -18,7 +19,11 @@ module Command
       one_off_workload = config[:one_off_workload]
       maintenance_workload = config.current[:maintenance_workload] || "maintenance"
 
-      domain_data = cp.find_domain_for([one_off_workload, maintenance_workload])
+      domain_data = if config.domain
+                      cp.fetch_domain(config.domain)
+                    else
+                      cp.find_domain_for([one_off_workload, maintenance_workload])
+                    end
       unless domain_data
         raise "Can't find domain. " \
               "Maintenance mode is only supported for domains that use path based routing mode " \
@@ -26,8 +31,7 @@ module Command
       end
 
       domain = domain_data["name"]
-      domain_workload = cp.get_domain_workload(domain_data)
-      if domain_workload == one_off_workload
+      if cp.domain_workload_matches?(domain_data, one_off_workload)
         progress.puts("Maintenance mode is already disabled for app '#{config.app}'.")
         return
       end

data/lib/command/maintenance_on.rb

@@ -4,7 +4,8 @@ module Command
   class MaintenanceOn < Base
     NAME = "maintenance:on"
     OPTIONS = [
-      app_option(required: true)
+      app_option(required: true),
+      domain_option
     ].freeze
     DESCRIPTION = "Enables maintenance mode for an app"
     LONG_DESCRIPTION = <<~DESC
@@ -18,7 +19,11 @@ module Command
       one_off_workload = config[:one_off_workload]
       maintenance_workload = config.current[:maintenance_workload] || "maintenance"
 
-      domain_data = cp.find_domain_for([one_off_workload, maintenance_workload])
+      domain_data = if config.domain
+                      cp.fetch_domain(config.domain)
+                    else
+                      cp.find_domain_for([one_off_workload, maintenance_workload])
+                    end
       unless domain_data
         raise "Can't find domain. " \
               "Maintenance mode is only supported for domains that use path based routing mode " \
@@ -26,8 +31,7 @@ module Command
       end
 
       domain = domain_data["name"]
-      domain_workload = cp.get_domain_workload(domain_data)
-      if domain_workload == maintenance_workload
+      if cp.domain_workload_matches?(domain_data, maintenance_workload)
         progress.puts("Maintenance mode is already enabled for app '#{config.app}'.")
         return
       end

data/lib/command/run.rb

@@ -29,56 +29,53 @@ module Command
       cpl run -a $APP_NAME
 
       # Need to quote COMMAND if setting ENV value or passing args.
-      cpl run 'LOG_LEVEL=warn rails db:migrate' -a $APP_NAME
-
-      # COMMAND may also be passed at the end.
       cpl run -a $APP_NAME -- 'LOG_LEVEL=warn rails db:migrate'
 
       # Runs command, displays output, and exits shell.
-      cpl run ls / -a $APP_NAME
-      cpl run rails db:migrate:status -a $APP_NAME
+      cpl run -a $APP_NAME -- ls /
+      cpl run -a $APP_NAME -- rails db:migrate:status
 
       # Runs command and keeps shell open.
-      cpl run rails c -a $APP_NAME
+      cpl run -a $APP_NAME -- rails c
 
       # Uses a different image (which may not be promoted yet).
-      cpl run rails db:migrate -a $APP_NAME --image appimage:123 # Exact image name
-      cpl run rails db:migrate -a $APP_NAME --image latest       # Latest sequential image
+      cpl run -a $APP_NAME --image appimage:123 -- rails db:migrate # Exact image name
+      cpl run -a $APP_NAME --image latest -- rails db:migrate       # Latest sequential image
 
       # Uses a different workload than `one_off_workload` from `.controlplane/controlplane.yml`.
-      cpl run bash -a $APP_NAME -w other-workload
+      cpl run -a $APP_NAME -w other-workload -- bash
 
       # Overrides remote CPLN_TOKEN env variable with local token.
       # Useful when superuser rights are needed in remote container.
-      cpl run bash -a $APP_NAME --use-local-token
+      cpl run -a $APP_NAME --use-local-token -- bash
       ```
     EX
 
-    attr_reader :location, :workload, :one_off, :container
+    attr_reader :location, :workload_to_clone, :workload_clone, :container
 
     def call # rubocop:disable Metrics/MethodLength
       @location = config.location
-      @workload = config.options["workload"] || config[:one_off_workload]
-      @one_off = "#{workload}-run-#{rand(1000..9999)}"
+      @workload_to_clone = config.options["workload"] || config[:one_off_workload]
+      @workload_clone = "#{workload_to_clone}-run-#{random_four_digits}"
 
-      step("Cloning workload '#{workload}' on app '#{config.options[:app]}' to '#{one_off}'") do
+      step("Cloning workload '#{workload_to_clone}' on app '#{config.options[:app]}' to '#{workload_clone}'") do
         clone_workload
       end
 
-      wait_for_workload(one_off)
-      wait_for_replica(one_off, location)
+      wait_for_workload(workload_clone)
+      wait_for_replica(workload_clone, location)
       run_in_replica
     ensure
       progress.puts
-      ensure_workload_deleted(one_off)
+      ensure_workload_deleted(workload_clone)
     end
 
     private
 
     def clone_workload # rubocop:disable Metrics/MethodLength
       # Create a base copy of workload props
-      spec = cp.fetch_workload!(workload).fetch("spec")
-      container_spec = spec["containers"].detect { _1["name"] == workload } || spec["containers"].first
+      spec = cp.fetch_workload!(workload_to_clone).fetch("spec")
+      container_spec = spec["containers"].detect { _1["name"] == workload_to_clone } || spec["containers"].first
       @container = container_spec["name"]
 
       # remove other containers if any
@@ -111,7 +108,7 @@ module Command
       end
 
       # Create workload clone
-      cp.apply_hash("kind" => "workload", "name" => one_off, "spec" => spec)
+      cp.apply_hash("kind" => "workload", "name" => workload_clone, "spec" => spec)
     end
 
     def runner_script # rubocop:disable Metrics/MethodLength
@@ -141,7 +138,7 @@ module Command
     def run_in_replica
       progress.puts("Connecting...\n\n")
       command = %(bash -c 'eval "$CONTROLPLANE_RUNNER"')
-      cp.workload_exec(one_off, location: location, container: container, command: command)
+      cp.workload_exec(workload_clone, location: location, container: container, command: command)
     end
   end
 end

data/lib/command/run_detached.rb

@@ -10,7 +10,8 @@ module Command
       image_option,
       workload_option,
       location_option,
-      use_local_token_option
+      use_local_token_option,
+      clean_on_failure_option
     ].freeze
     DESCRIPTION = "Runs one-off **_non-interactive_** replicas (close analog of `heroku run:detached`)"
     LONG_DESCRIPTION = <<~DESC
@@ -19,50 +20,46 @@ module Command
       - Implemented with only async execution methods, more suitable for production tasks
       - Has alternative log fetch implementation with only JSON-polling and no WebSockets
       - Less responsive but more stable, useful for CI tasks
+      - Deletes the workload whenever finished with success
+      - Deletes the workload whenever finished with failure by default
+      - Use `--no-clean-on-failure` to disable cleanup to help with debugging failed runs
     DESC
     EXAMPLES = <<~EX
       ```sh
       cpl run:detached rails db:prepare -a $APP_NAME
 
       # Need to quote COMMAND if setting ENV value or passing args.
-      cpl run:detached 'LOG_LEVEL=warn rails db:migrate' -a $APP_NAME
-
-      # COMMAND may also be passed at the end.
       cpl run:detached -a $APP_NAME -- 'LOG_LEVEL=warn rails db:migrate'
 
       # Uses a different image (which may not be promoted yet).
-      cpl run:detached rails db:migrate -a $APP_NAME --image appimage:123 # Exact image name
-      cpl run:detached rails db:migrate -a $APP_NAME --image latest       # Latest sequential image
+      cpl run:detached -a $APP_NAME --image appimage:123 -- rails db:migrate # Exact image name
+      cpl run:detached -a $APP_NAME --image latest -- rails db:migrate       # Latest sequential image
 
       # Uses a different workload than `one_off_workload` from `.controlplane/controlplane.yml`.
-      cpl run:detached rails db:migrate:status -a $APP_NAME -w other-workload
+      cpl run:detached -a $APP_NAME -w other-workload -- rails db:migrate:status
 
       # Overrides remote CPLN_TOKEN env variable with local token.
       # Useful when superuser rights are needed in remote container.
-      cpl run:detached rails db:migrate:status -a $APP_NAME --use-local-token
+      cpl run:detached -a $APP_NAME --use-local-token -- rails db:migrate:status
       ```
     EX
 
     WORKLOAD_SLEEP_CHECK = 2
 
-    attr_reader :location, :workload, :one_off, :container
+    attr_reader :location, :workload_to_clone, :workload_clone, :container
 
-    def call # rubocop:disable Metrics/MethodLength
+    def call
       @location = config.location
-      @workload = config.options["workload"] || config[:one_off_workload]
-      @one_off = "#{workload}-runner-#{rand(1000..9999)}"
+      @workload_to_clone = config.options["workload"] || config[:one_off_workload]
+      @workload_clone = "#{workload_to_clone}-runner-#{random_four_digits}"
 
-      step("Cloning workload '#{workload}' on app '#{config.options[:app]}' to '#{one_off}'") do
+      step("Cloning workload '#{workload_to_clone}' on app '#{config.options[:app]}' to '#{workload_clone}'") do
         clone_workload
       end
 
-      wait_for_workload(one_off)
+      wait_for_workload(workload_clone)
       show_logs_waiting
     ensure
-      if cp.fetch_workload(one_off)
-        progress.puts
-        ensure_workload_deleted(one_off)
-      end
       exit(1) if @crashed
     end
 
@@ -70,8 +67,8 @@ module Command
 
     def clone_workload # rubocop:disable Metrics/MethodLength
       # Get base specs of workload
-      spec = cp.fetch_workload!(workload).fetch("spec")
-      container_spec = spec["containers"].detect { _1["name"] == workload } || spec["containers"].first
+      spec = cp.fetch_workload!(workload_to_clone).fetch("spec")
+      container_spec = spec["containers"].detect { _1["name"] == workload_to_clone } || spec["containers"].first
       @container = container_spec["name"]
 
       # remove other containers if any
@@ -105,7 +102,7 @@ module Command
       container_spec["env"] << { "name" => "CONTROLPLANE_RUNNER", "value" => runner_script }
 
       # Create workload clone
-      cp.apply_hash("kind" => "workload", "name" => one_off, "spec" => spec)
+      cp.apply_hash("kind" => "workload", "name" => workload_clone, "spec" => spec)
     end
 
     def runner_script # rubocop:disable Metrics/MethodLength
@@ -119,12 +116,20 @@ module Command
       end
 
       script += <<~SHELL
-        if ! eval "#{args_join(config.args)}"; then echo "----- CRASHED -----"; fi
-
-        echo "-- FINISHED RUNNER SCRIPT, DELETING WORKLOAD --"
-        sleep 10 # grace time for logs propagation
-        curl ${CPLN_ENDPOINT}${CPLN_WORKLOAD} -H "Authorization: ${CONTROLPLANE_TOKEN}" -X DELETE -s -o /dev/null
-        while true; do sleep 1; done # wait for SIGTERM
+        crashed=0
+        if ! eval "#{args_join(config.args)}"; then
+          crashed=1
+          echo "----- CRASHED -----"
+        fi
+        clean_on_failure=#{config.options[:clean_on_failure] ? 1 : 0}
+        if [ $crashed -eq 0 ] || [ $clean_on_failure -eq 1 ]; then
+          echo "-- FINISHED RUNNER SCRIPT, DELETING WORKLOAD --"
+          sleep 30 # grace time for logs propagation
+          curl ${CPLN_ENDPOINT}${CPLN_WORKLOAD} -H "Authorization: ${CONTROLPLANE_TOKEN}" -X DELETE -s -o /dev/null
+          while true; do sleep 1; done # wait for SIGTERM
+        else
+          echo "-- FINISHED RUNNER SCRIPT --"
+        fi
       SHELL
 
       script
@@ -133,7 +138,8 @@ module Command
     def show_logs_waiting # rubocop:disable Metrics/MethodLength
       progress.puts("Scheduled, fetching logs (it's a cron job, so it may take up to a minute to start)...\n\n")
       begin
-        while cp.fetch_workload(one_off)
+        @finished = false
+        while cp.fetch_workload(workload_clone) && !@finished
           sleep(WORKLOAD_SLEEP_CHECK)
           print_uniq_logs
         end
@@ -151,6 +157,7 @@ module Command
 
       (entries - @printed_log_entries).sort.each do |(_ts, val)|
         @crashed = true if val.match?(/^----- CRASHED -----$/)
+        @finished = true if val.match?(/^-- FINISHED RUNNER SCRIPT(, DELETING WORKLOAD)? --$/)
         puts val
       end
 
@@ -158,7 +165,7 @@ module Command
     end
 
     def normalized_log_entries(from:, to:)
-      log = cp.log_get(workload: one_off, from: from, to: to)
+      log = cp.log_get(workload: workload_clone, from: from, to: to)
 
       log["data"]["result"]
         .each_with_object([]) { |obj, result| result.concat(obj["values"]) }

data/lib/core/config.rb

@@ -38,6 +38,10 @@ class Config # rubocop:disable Metrics/ClassLength
     @location ||= load_location_from_options || load_location_from_env || load_location_from_file
   end
 
+  def domain
+    @domain ||= load_domain_from_options || load_domain_from_file
+  end
+
   def [](key)
     ensure_current_config!
 
@@ -98,6 +102,20 @@ class Config # rubocop:disable Metrics/ClassLength
     end
   end
 
+  def app_matches?(app_name1, app_name2, app_options)
+    app_name1 && app_name2 &&
+      (app_name1.to_s == app_name2.to_s ||
+        (app_options[:match_if_app_name_starts_with] && app_name1.to_s.start_with?(app_name2.to_s))
+      )
+  end
+
+  def find_app_config(app_name1)
+    @app_configs ||= {}
+    @app_configs[app_name1] ||= apps.find do |app_name2, app_config|
+                                  app_matches?(app_name1, app_name2, app_config)
+                                end&.last
+  end
+
   private
 
   def ensure_current_config!
@@ -116,20 +134,6 @@ class Config # rubocop:disable Metrics/ClassLength
     raise "Can't find config for app '#{app_name}' in 'controlplane.yml'." unless app_options
   end
 
-  def app_matches?(app_name1, app_name2, app_options)
-    app_name1 && app_name2 &&
-      (app_name1.to_s == app_name2.to_s ||
-        (app_options[:match_if_app_name_starts_with] && app_name1.to_s.start_with?(app_name2.to_s))
-      )
-  end
-
-  def find_app_config(app_name1)
-    @app_configs ||= {}
-    @app_configs[app_name1] ||= apps.find do |app_name2, app_config|
-                                  app_matches?(app_name1, app_name2, app_config)
-                                end&.last
-  end
-
   def ensure_app!
     return if app
 
@@ -253,6 +257,16 @@ class Config # rubocop:disable Metrics/ClassLength
     strip_str_and_validate(current.fetch(:default_location))
   end
 
+  def load_domain_from_options
+    strip_str_and_validate(options[:domain])
+  end
+
+  def load_domain_from_file
+    return unless current&.key?(:default_domain)
+
+    strip_str_and_validate(current.fetch(:default_domain))
+  end
+
   def warn_deprecated_options(app_options)
     deprecated_option_keys = new_option_keys.select { |old_key| app_options.key?(old_key) }
     return if deprecated_option_keys.empty?

data/lib/core/controlplane.rb

@@ -44,12 +44,13 @@ class Controlplane # rubocop:disable Metrics/ClassLength
     api.query_images(org: a_org, gvc: a_gvc, gvc_op_type: gvc_op)
   end
 
-  def image_build(image, dockerfile:, build_args: [], push: true)
+  def image_build(image, dockerfile:, docker_args: [], build_args: [], push: true)
     # https://docs.controlplane.com/guides/push-image#step-2
     # Might need to use `docker buildx build` if compatiblitity issues arise
     cmd = "docker build --platform=linux/amd64 -t #{image} -f #{dockerfile}"
     cmd += " --progress=plain" if ControlplaneApiDirect.trace
 
+    cmd += " #{docker_args.join(' ')}" if docker_args.any?
     build_args.each { |build_arg| cmd += " --build-arg #{build_arg}" }
     cmd += " #{config.app_dir}"
     perform!(cmd)
@@ -264,13 +265,21 @@ class Controlplane # rubocop:disable Metrics/ClassLength
       route = find_domain_route(domain_data)
       next false if route.nil?
 
-      workloads.any? { |workload| route["workloadLink"].split("/").last == workload }
+      workloads.any? { |workload| route["workloadLink"].match?(%r{/org/#{org}/gvc/#{gvc}/workload/#{workload}}) }
     end
   end
 
-  def get_domain_workload(data)
+  def fetch_domain(domain)
+    domain_data = api.fetch_domain(org: org, domain: domain)
+    route = find_domain_route(domain_data)
+    return nil if route.nil?
+
+    domain_data
+  end
+
+  def domain_workload_matches?(data, workload)
     route = find_domain_route(data)
-    route["workloadLink"].split("/").last
+    route["workloadLink"].match?(%r{/org/#{org}/gvc/#{gvc}/workload/#{workload}})
   end
 
   def set_domain_workload(data, workload)

data/lib/core/controlplane_api.rb

@@ -94,6 +94,10 @@ class ControlplaneApi # rubocop:disable Metrics/ClassLength
     api_json("/org/#{org}/gvc/#{gvc}/volumeset/#{volumeset}", method: :delete)
   end
 
+  def fetch_domain(org:, domain:)
+    api_json("/org/#{org}/domain/#{domain}", method: :get)
+  end
+
   def list_domains(org:)
     api_json("/org/#{org}/domain", method: :get)
   end

data/lib/core/helpers.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "securerandom"
+
 module Helpers
   def strip_str_and_validate(str)
     return str if str.nil?
@@ -7,4 +9,8 @@ module Helpers
     str = str.strip
     str.empty? ? nil : str
   end
+
+  def random_four_digits
+    SecureRandom.random_number(1000..9999)
+  end
 end

data/lib/cpl/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Cpl
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
   MIN_CPLN_VERSION = "0.0.71"
 end

data/lib/cpl.rb

@@ -142,6 +142,7 @@ module Cpl
       requires_args = command_class::REQUIRES_ARGS
       default_args = command_class::DEFAULT_ARGS
       command_options = command_class::OPTIONS + ::Command::Base.common_options
+      accepts_extra_options = command_class::ACCEPTS_EXTRA_OPTIONS
       description = command_class::DESCRIPTION
       long_description = command_class::LONG_DESCRIPTION
       examples = command_class::EXAMPLES
@@ -178,7 +179,9 @@ module Cpl
                  default_args
                end
 
-        raise_args_error.call(args, nil) if (args.empty? && requires_args) || (!args.empty? && !requires_args)
+        if (args.empty? && requires_args) || (!args.empty? && !requires_args && !accepts_extra_options)
+          raise_args_error.call(args, nil)
+        end
 
         begin
           config = Config.new(args, options, required_options)

data/script/check_cpln_links

@@ -0,0 +1,45 @@
+#!/usr/bin/env bash
+
+bad_links=("controlplane.com/shakacode")
+proper_links=("shakacode.controlplane.com")
+
+bold=$(tput bold)
+normal=$(tput sgr0)
+
+exit_status=0
+accumulated_results=""
+seen_bad_links_indexes=()
+
+for ((idx = 0; idx < ${#bad_links[@]}; idx++)); do
+    results=$(git grep \
+        --recursive \
+        --line-number \
+        --fixed-strings \
+        --break \
+        --heading \
+        --color=always -- \
+        "${bad_links[idx]}" \
+        ':!script/check_cpln_links')
+
+    # Line would become really unwieldly if everything was mushed into the
+    # conditional, so let's ignore this check here.
+    # shellcheck disable=SC2181
+    if [ $? -eq 0 ]; then
+        accumulated_results+="$results"
+        seen_bad_links_indexes+=("$idx")
+        exit_status=1
+    fi
+done
+
+if [ "$exit_status" -eq 1 ]; then
+    echo "${bold}[!] Found the following bad links:${normal}"
+    echo ""
+    echo "$accumulated_results"
+    echo ""
+    echo "${bold}[*] Please update accordingly:${normal}"
+    for bad_link_index in "${seen_bad_links_indexes[@]}"; do
+        echo "  ${bad_links[bad_link_index]} -> ${proper_links[bad_link_index]}"
+    done
+fi
+
+exit "$exit_status"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cpl
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Justin Gordon
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-04 00:00:00.000000000 Z
+date: 2024-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debug
@@ -202,6 +202,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/check_cpln_links.yml"
 - ".github/workflows/command_docs.yml"
 - ".github/workflows/rspec.yml"
 - ".github/workflows/rubocop.yml"
@@ -223,6 +224,7 @@ files:
 - docs/assets/memcached.png
 - docs/assets/sidekiq-pre-stop-hook.png
 - docs/commands.md
+- docs/dns.md
 - docs/migrating.md
 - docs/postgres.md
 - docs/redis.md
@@ -285,6 +287,7 @@ files:
 - rakelib/create_release.rake
 - script/add_command
 - script/check_command_docs
+- script/check_cpln_links
 - script/rename_command
 - script/update_command_docs
 - templates/daily-task.yml