Merge pull request #821 from linode/dev

ezilber-akamai · web-flow · commit 1ebbdb8a2e30 · 2025-10-02T09:29:04.000-04:00
Release v5.63.0
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -20,7 +20,7 @@ jobs:
         uses: actions/checkout@v5
 
       - name: setup python 3
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: '3.x'
 
@@ -40,7 +40,7 @@ jobs:
         uses: actions/checkout@v5
 
       - name: Setup Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -62,7 +62,7 @@ jobs:
         uses: actions/checkout@v5
 
       - name: Setup Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.x"
 
diff --git a/.github/workflows/e2e-suite-windows.yml b/.github/workflows/e2e-suite-windows.yml
@@ -61,7 +61,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Setup Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: '3.x'
 
@@ -74,7 +74,7 @@ jobs:
         env:
           LINODE_CLI_TOKEN: ${{ secrets.LINODE_TOKEN_2 }}
 
-      - uses: actions/github-script@v7
+      - uses: actions/github-script@v8
         id: update-check-run
         if: ${{ inputs.pull_request_number != '' && fromJson(steps.commit-hash.outputs.data).repository.pullRequest.headRef.target.oid == inputs.sha }}
         env:
@@ -135,7 +135,7 @@ jobs:
 
     steps:
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: '3.x'
 
diff --git a/.github/workflows/e2e-suite.yml b/.github/workflows/e2e-suite.yml
@@ -98,7 +98,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Setup Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ inputs.run-eol-python-version == 'true' && env.EOL_PYTHON_VERSION || inputs.python-version || env.DEFAULT_PYTHON_VERSION }}
 
@@ -135,7 +135,7 @@ jobs:
           retention-days: 1
 
       - name: Update PR Check Run
-        uses: actions/github-script@v7
+        uses: actions/github-script@v8
         id: update-check-run
         if: ${{ inputs.pull_request_number != '' && fromJson(steps.commit-hash.outputs.data).repository.pullRequest.headRef.target.oid == inputs.sha }}
         env:
@@ -200,7 +200,7 @@ jobs:
 
     steps:
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: '3.x'
 
@@ -248,7 +248,7 @@ jobs:
           name: test-report-file
 
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: '3.x'
 
diff --git a/.github/workflows/nightly-smoke-tests.yml b/.github/workflows/nightly-smoke-tests.yml
@@ -25,7 +25,7 @@ jobs:
           ref: ${{ github.event.inputs.sha || github.ref }}
 
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: '3.x'
 
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -31,7 +31,7 @@ jobs:
         uses: actions/checkout@v5
 
       - name: setup python 3
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: '3.x'
 
@@ -45,15 +45,15 @@ jobs:
         uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # pin@v3.11.1
 
       - name: Login to Docker Hub
-        uses: docker/login-action@184bdaa0721073962dff0199f1fb9940f07167d1 # pin@v3.5.0
+        uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # pin@v3.6.0
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
       # This is necessary as we want to ensure that version tags
       # are properly formatted before passing them into the
       # DockerFile.
-      - uses: actions/github-script@v7
+      - uses: actions/github-script@v8
         id: cli_version
         with:
           script: |
@@ -89,7 +89,7 @@ jobs:
         uses: actions/checkout@v5
 
       - name: Setup Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: '3.x'
 
@@ -106,4 +106,4 @@ jobs:
           LINODE_CLI_VERSION: ${{ github.event.release.tag_name }}
 
       - name: Publish the release artifacts to PyPI
-        uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # pin@release/v1.12.4
+        uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # pin@release/v1.13.0
diff --git a/.github/workflows/remote-release-trigger.yml b/.github/workflows/remote-release-trigger.yml
@@ -29,7 +29,7 @@ jobs:
 
       - name: Calculate the desired release version
         id: calculate_version
-        uses: actions/github-script@v7
+        uses: actions/github-script@v8
         env:
           SPEC_VERSION: ${{ github.event.client_payload.spec_version }}
           PREVIOUS_CLI_VERSION: ${{ steps.previoustag.outputs.tag }}
@@ -66,7 +66,7 @@ jobs:
           commit_sha: ${{ steps.calculate_head_sha.outputs.commit_sha }}
 
       - name: Release
-        uses: softprops/action-gh-release@72f2c25fcb47643c292f7107632f7a47c1df5cd8 # pin@v2.3.2
+        uses: softprops/action-gh-release@6cbd405e2c4e67a21c47fa9e383d020e4e28b836 # pin@v2.3.3
         with:
           target_commitish: 'main'
           token: ${{ steps.generate_token.outputs.token }}
diff --git a/linodecli/__init__.py b/linodecli/__init__.py
@@ -20,6 +20,7 @@
 from .cli import CLI
 from .completion import get_completions
 from .configuration import ENV_TOKEN_NAME
+from .help_formatter import SortingHelpFormatter
 from .help_pages import (
     HELP_TOPICS,
     print_help_action,
@@ -64,6 +65,7 @@ def main():  # pylint: disable=too-many-branches,too-many-statements
     parser = argparse.ArgumentParser(
         "linode-cli",
         add_help=False,
+        formatter_class=SortingHelpFormatter,
         description="The Linode Command Line Interface.\n\nAliases: lin, linode",
     )
     parsed, args = register_args(parser).parse_known_args()
diff --git a/linodecli/baked/operation.py b/linodecli/baked/operation.py
@@ -29,6 +29,7 @@
 from linodecli.baked.response import OpenAPIResponse
 from linodecli.baked.util import unescape_arg_segment
 from linodecli.exit_codes import ExitCodes
+from linodecli.help_formatter import SortingHelpFormatter
 from linodecli.output.output_handler import OutputHandler
 from linodecli.overrides import OUTPUT_OVERRIDES
 
@@ -831,6 +832,7 @@ def parse_args(self, args: Any) -> argparse.Namespace:
         #  build an argparse
         parser = argparse.ArgumentParser(
             prog=f"linode-cli {self.command} {self.action}",
+            formatter_class=SortingHelpFormatter,
             description=self.summary,
         )
         for param in self.params:
diff --git a/linodecli/cli.py b/linodecli/cli.py
@@ -10,7 +10,7 @@
 from json import JSONDecodeError
 from logging import getLogger
 from sys import version_info
-from typing import IO, Any, ContextManager, Dict
+from typing import IO, Any, Dict
 
 import requests
 import yaml
@@ -311,7 +311,7 @@ def _load_openapi_spec(spec_location: str) -> OpenAPI:
     @contextlib.contextmanager
     def _get_spec_file_reader(
         spec_location: str,
-    ) -> ContextManager[IO]:
+    ):
         """
         Returns a reader for an OpenAPI spec file from the given location.
 
diff --git a/linodecli/configuration/config.py b/linodecli/configuration/config.py
@@ -364,7 +364,7 @@ def configure(
             if _check_browsers() and not self.configure_with_pat:
                 print(
                     "The CLI will use its web-based authentication to log you in.\n"
-                    "If you prefer to supply a Personal Access Token,"
+                    "If you prefer to supply a Personal Access Token, "
                     "use `linode-cli configure --token`."
                 )
                 input(
diff --git a/linodecli/help_formatter.py b/linodecli/help_formatter.py
@@ -0,0 +1,16 @@
+"""
+Contains sorting formatter for help menu.
+"""
+
+from argparse import HelpFormatter
+from operator import attrgetter
+
+
+class SortingHelpFormatter(HelpFormatter):
+    """
+    The formatter class for help menu.
+    """
+
+    def add_arguments(self, actions):
+        actions = sorted(actions, key=attrgetter("option_strings"))
+        super().add_arguments(actions)
diff --git a/linodecli/plugins/firewall-editor.py b/linodecli/plugins/firewall-editor.py
@@ -15,6 +15,7 @@
 from rich.table import Table
 
 from linodecli.exit_codes import ExitCodes
+from linodecli.help_formatter import SortingHelpFormatter
 from linodecli.plugins import inherit_plugin_args
 
 BOLD = "\033[1m"
@@ -581,8 +582,13 @@ def call(args, context):
     Invokes the Interactive Firewall Plugin
     """
     parser = inherit_plugin_args(
-        argparse.ArgumentParser("firewall-editor", add_help=True)
+        argparse.ArgumentParser(
+            "firewall-editor",
+            add_help=True,
+            formatter_class=SortingHelpFormatter,
+        )
     )
+
     parser.add_argument("firewall_id", help="The ID of the firewall to edit.")
 
     parsed = parser.parse_args(args)
diff --git a/linodecli/plugins/get-kubeconfig.py b/linodecli/plugins/get-kubeconfig.py
@@ -14,6 +14,7 @@
 import yaml
 
 from linodecli.exit_codes import ExitCodes
+from linodecli.help_formatter import SortingHelpFormatter
 
 PLUGIN_BASE = "linode-cli get-kubeconfig"
 
@@ -22,7 +23,9 @@ def call(args, context):
     """
     The entrypoint for this plugin
     """
-    parser = argparse.ArgumentParser(PLUGIN_BASE, add_help=True)
+    parser = argparse.ArgumentParser(
+        PLUGIN_BASE, add_help=True, formatter_class=SortingHelpFormatter
+    )
 
     group = parser.add_mutually_exclusive_group()
 
diff --git a/linodecli/plugins/image-upload.py b/linodecli/plugins/image-upload.py
@@ -15,6 +15,7 @@
 import requests
 
 from linodecli.exit_codes import ExitCodes
+from linodecli.help_formatter import SortingHelpFormatter
 from linodecli.plugins import inherit_plugin_args
 
 PLUGIN_BASE = "linode-cli image-upload"
@@ -68,7 +69,9 @@ def call(args, context):
     The entrypoint for this plugin
     """
     parser = inherit_plugin_args(
-        argparse.ArgumentParser(PLUGIN_BASE, add_help=True)
+        argparse.ArgumentParser(
+            PLUGIN_BASE, add_help=True, formatter_class=SortingHelpFormatter
+        )
     )
 
     parser.add_argument(
diff --git a/linodecli/plugins/metadata.py b/linodecli/plugins/metadata.py
@@ -17,6 +17,7 @@
 from rich.table import Table
 
 from linodecli.exit_codes import ExitCodes
+from linodecli.help_formatter import SortingHelpFormatter
 from linodecli.helpers import register_debug_arg
 
 PLUGIN_BASE = "linode-cli metadata"
@@ -184,7 +185,9 @@ def get_metadata_parser():
     """
     Builds argparser for Metadata plug-in
     """
-    parser = ArgumentParser(PLUGIN_BASE, add_help=False)
+    parser = ArgumentParser(
+        PLUGIN_BASE, add_help=False, formatter_class=SortingHelpFormatter
+    )
 
     register_debug_arg(parser)
 
diff --git a/linodecli/plugins/obj/__init__.py b/linodecli/plugins/obj/__init__.py
@@ -20,6 +20,7 @@
 from linodecli.configuration import _do_get_request
 from linodecli.configuration.helpers import _default_text_input
 from linodecli.exit_codes import ExitCodes
+from linodecli.help_formatter import SortingHelpFormatter
 from linodecli.plugins import PluginContext, inherit_plugin_args
 from linodecli.plugins.obj.buckets import create_bucket, delete_bucket
 from linodecli.plugins.obj.config import (
@@ -68,7 +69,11 @@ def generate_url(get_client, args, **kwargs):  # pylint: disable=unused-argument
     """
     Generates a URL to an object
     """
-    parser = inherit_plugin_args(ArgumentParser(PLUGIN_BASE + " signurl"))
+    parser = inherit_plugin_args(
+        ArgumentParser(
+            PLUGIN_BASE + " signurl", formatter_class=SortingHelpFormatter
+        )
+    )
 
     parser.add_argument(
         "bucket",
@@ -119,7 +124,11 @@ def set_acl(get_client, args, **kwargs):  # pylint: disable=unused-argument
     """
     Modify Access Control List for a Bucket or Objects
     """
-    parser = inherit_plugin_args(ArgumentParser(PLUGIN_BASE + " setacl"))
+    parser = inherit_plugin_args(
+        ArgumentParser(
+            PLUGIN_BASE + " setacl", formatter_class=SortingHelpFormatter
+        )
+    )
 
     parser.add_argument(
         "bucket", metavar="BUCKET", type=str, help="The bucket to modify."
@@ -183,7 +192,11 @@ def show_usage(get_client, args, **kwargs):  # pylint: disable=unused-argument
     """
     Shows space used by all buckets in this cluster, and total space
     """
-    parser = inherit_plugin_args(ArgumentParser(PLUGIN_BASE + " du"))
+    parser = inherit_plugin_args(
+        ArgumentParser(
+            PLUGIN_BASE + " du", formatter_class=SortingHelpFormatter
+        )
+    )
 
     parser.add_argument(
         "bucket",
@@ -290,7 +303,11 @@ def get_obj_args_parser():
     """
     Initialize and return the argument parser for the obj plug-in.
     """
-    parser = inherit_plugin_args(ArgumentParser(PLUGIN_BASE, add_help=False))
+    parser = inherit_plugin_args(
+        ArgumentParser(
+            PLUGIN_BASE, add_help=False, formatter_class=SortingHelpFormatter
+        )
+    )
 
     parser.add_argument(
         "command",
diff --git a/linodecli/plugins/obj/buckets.py b/linodecli/plugins/obj/buckets.py
diff --git a/linodecli/plugins/obj/list.py b/linodecli/plugins/obj/list.py
diff --git a/linodecli/plugins/obj/objects.py b/linodecli/plugins/obj/objects.py
diff --git a/linodecli/plugins/obj/website.py b/linodecli/plugins/obj/website.py
diff --git a/linodecli/plugins/ssh.py b/linodecli/plugins/ssh.py
diff --git a/tests/integration/lke/test_clusters.py b/tests/integration/lke/test_clusters.py

Original file line number	Diff line number	Diff line change
`@@ -364,7 +364,7 @@ def configure(`
`364`	`364`	`if _check_browsers() and not self.configure_with_pat:`
`365`	`365`	`print(`
`366`	`366`	`"The CLI will use its web-based authentication to log you in.\n"`
`367`		`- "If you prefer to supply a Personal Access Token,"`
	`367`	`+ "If you prefer to supply a Personal Access Token, "`
`368`	`368`	"use `linode-cli configure --token`."
`369`	`369`	`)`
`370`	`370`	`input(`