Deprecate "local upload" related commands (#679)

This hides all related commands and options from the docs, and removes mentions of them from the README.

Author: Swatinem

README.md

@@ -17,12 +17,9 @@ CodecovCLI is a new way for users to interact with Codecov directly from the use
   - [create-commit](#create-commit)
   - [create-report](#create-report)
   - [do-upload](#do-upload)
-  - [create-report-results](#create-report-results)
-  - [get-report-results](#get-report-results)
   - [pr-base-picking](#pr-base-picking)
   - [send-notifications](#send-notifications)
   - [empty-upload](#empty-upload)
-- [How to Use Local Upload](#how-to-use-local-upload)
 - [Work in Progress Features](#work-in-progress-features)
   - [Plugin System](#plugin-system)
   - [Static Analysis](#static-analysis)
@@ -123,8 +120,6 @@ Codecov-cli supports user input. These inputs, along with their descriptions and
 | `create-commit` | Saves the commit's metadata in codecov, it's only necessary to run this once per commit
 | `create-report` | Creates an empty report in codecov with initial data e.g. report name, report's commit
 | `do-upload` | Searches for and uploads coverage data to codecov
-| `create-report-results` | Used for local upload. It tells codecov that you finished local uploading and want it to calculate the results for you to get them locally.
-| `get-report-results` | Used for local upload. It asks codecov to provide you the report results you calculated with the previous command.
 | `pr-base-picking` | Tells codecov that you want to explicitly define a base for your PR
 | `upload-process` | A wrapper for 3 commands. Create-commit, create-report and do-upload. You can use this command to upload to codecov instead of using the previously mentioned commands.
 | `send-notifications` | A command that tells Codecov that you finished uploading and you want to be sent notifications. To disable automatically sent notifications please consider adding manual_trigger to your codecov.yml, so it will look like codecov: notify: manual_trigger: true.
@@ -156,7 +151,6 @@ Codecov-cli supports user input. These inputs, along with their descriptions and
 |-r, --slug | owner/repo slug used instead of the private repo token in Self-hosted | Required
 |-t, --token | Codecov upload token | Required
 |--git-service | Git Provider. Options: github, gitlab, bitbucket, github_enterprise, gitlab_enterprise, bitbucket_server | Required
-|--code| The code of the report. This is used in local uploading to isolate local reports from regular or cloud reports uploaded to codecov so they don't get merged. It's basically a name you give to your report e.g. local-report. | Optional
 |-h, --help | Shows usage, and command options
 
 ## do-upload
@@ -165,7 +159,6 @@ Codecov-cli supports user input. These inputs, along with their descriptions and
 | Option  | Description | Usage
 | :---:     |     :---:   |    :---:   |
 |-C, --sha, --commit-sha|    Commit SHA (with 40 chars) | Required
-|--report-code | The code of the report defined when creating the report. If unsure, leave default | Optional
 |--network-root-folder |      Root folder from which to consider paths on the network section  default: (Current working directory) | Optional
 |-s, --dir, --coverage-files-search-root-folder | Folder where to search for coverage files default: (Current Working Directory) | Optional
 |--exclude, --coverage-files-search-exclude-folder | Folders to exclude from search | Optional
@@ -189,30 +182,6 @@ Codecov-cli supports user input. These inputs, along with their descriptions and
 |--git-service | Git Provider. Options: github, gitlab, bitbucket, github_enterprise, gitlab_enterprise, bitbucket_server | Required
 |-h, --help | Shows usage, and command options
 
-## create-report-results
-`codecovcli create-report-results [OPTIONS]`
-
-| Option  | Description | Usage
-| :---:     |     :---:   |    :---:   |
-|--commit-sha | Commit SHA (with 40 chars) | Required
-|--code | The code of the report. If unsure, leave default | Required
-|--slug | owner/repo slug | Required
-|--git-service | Git provider. Options: github, gitlab, bitbucket, github_enterprise, gitlab_enterprise, bitbucket_server | Optional
-|-t, --token | Codecov upload token | Required
-|-h, --help | Shows usage, and command options
-
-## get-report-results
-`codecovcli get-report-results [OPTIONS]`
-
-| Option  | Description | Usage
-| :---:     |     :---:   |    :---:   |
-|--commit-sha | Commit SHA (with 40 chars) | Required
-|--code | The code of the report. If unsure, leave default | Required
-|--slug | owner/repo slug | Required
-|--git-service | Git provider. Options: github, gitlab, bitbucket, github_enterprise, gitlab_enterprise, bitbucket_server | Optional
-|-t, --token | Codecov upload token | Required
-|-h, --help | Shows usage, and command options
-
 ## pr-base-picking
 `codecovcli pr-base-picking [OPTIONS]`
 
@@ -254,25 +223,6 @@ are ignored by codecov (including README and configuration files)
 |        --git-service         | Options: github, gitlab, bitbucket, github_enterprise, gitlab_enterprise, bitbucket_server | Optional |
 |          -h, --help          |                                Show this message and exit.                                 | Optional |
 
-# How to Use Local Upload
-
-The CLI also supports "dry run" local uploading. This is useful if you prefer to see Codecov status checks and coverage reporting locally, in your terminal, as opposed to opening a PR and waiting for your full CI to run. Local uploads do not interfere with regular uploads made from your CI for any given commit / Pull Request.
-
-Local Upload is accomplished as follows:
-
-```
-pip install codecov-cli
-codecovcli create-commit
-codecovcli create-report --code <CODE>
-codecovcli do-upload --report-code <CODE>
-codecovcli create-report-results --code <CODE>
-codecovcli get-report-results --code <CODE>
-```
-
-Codecov will calculate the coverage results, and return them in your terminal, telling you whether your PR will fail or pass the coverage check.
-
-Note: In order for Local Upload to work, it must be used against a commit on the origin repository. Local Upload does not work for arbitrary diffs or uncommitted changes on your local machine.
-
 # Work in Progress Features
 
 The following features are somewhat implemented in code, but are not yet meant for use. These features will be documented once they are fully implemented in the CLI.
@@ -281,10 +231,6 @@ The following features are somewhat implemented in code, but are not yet meant f
 
 To provide extensibility to some of its commands, the CLI makes use of a plugin system. For most cases, the default commands are sufficient. But in some cases, having some custom logic specific to your use case can be beneficial. Note that full documentation of the plugin system is pending, as the feature is still heavily a work in progress.
 
-## Static Analysis
-
-The CLI can perform basic static analysis on Python code today. This static analysis is meant to power more future looking Codecov features and, as such, is not required or in active use today. As more functionality dependent on static analysis becomes available for use, we will document static analysis in detail here.
-
 # Contributions
 
 This repository, like all of Codecov's repositories, strives to follow our general [Contributing guidelines](https://github.com/codecov/contributing). If you're considering making a contribution to this repository, we encourage review of our Contributing guidelines first.

codecov_cli/commands/create_report_result.py

@@ -11,7 +11,7 @@
 logger = logging.getLogger("codecovcli")
 
 
-@click.command()
+@click.command(hidden=True, deprecated=True)
 @click.option(
     "--code", help="The code of the report. If unsure, leave default", default="default"
 )

codecov_cli/commands/get_report_results.py

@@ -3,10 +3,8 @@
 import click
 import sentry_sdk
 
-from codecov_cli.fallbacks import CodecovOption, FallbackFieldEnum
 from codecov_cli.helpers.args import get_cli_args
 from codecov_cli.helpers.encoder import encode_slug
-from codecov_cli.helpers.git import GitService
 from codecov_cli.helpers.options import global_options
 from codecov_cli.services.report import send_reports_result_get_request
 from codecov_cli.types import CommandContext
@@ -15,7 +13,7 @@
 logger = logging.getLogger("codecovcli")
 
 
-@click.command()
+@click.command(hidden=True, deprecated=True)
 @click.option(
     "--code", help="The code of the report. If unsure, leave default", default="default"
 )

codecov_cli/commands/report.py

@@ -14,7 +14,7 @@
 
 @click.command()
 @click.option(
-    "--code", help="The code of the report. If unsure, leave default", default="default"
+    "--code", help="The code of the report. If unsure, leave default", default="default", hidden=True
 )
 @click.option(
     "-P",

codecov_cli/commands/upload.py

@@ -26,6 +26,7 @@ def _turn_env_vars_into_dict(ctx, params, value):
         "report_code",
         help="The code of the report. If unsure, leave default",
         default="default",
+        hidden=True,
     ),
     click.option(
         "--network-root-folder",

codecov_cli/main.py

@@ -77,17 +77,19 @@ def cli(
 cli.add_command(do_upload)
 cli.add_command(create_commit)
 cli.add_command(create_report)
-cli.add_command(create_report_results)
-cli.add_command(get_report_results)
 cli.add_command(pr_base_picking)
-cli.add_command(label_analysis)
-cli.add_command(static_analysis)
 cli.add_command(empty_upload)
 cli.add_command(upload_coverage)
 cli.add_command(upload_process)
 cli.add_command(send_notifications)
 cli.add_command(process_test_results)
 
+# deprecated commands:
+cli.add_command(create_report_results)
+cli.add_command(get_report_results)
+cli.add_command(label_analysis)
+cli.add_command(static_analysis)
+
 
 def run():
     cli(obj={})

codecovcli_commands

@@ -13,10 +13,8 @@ Options:
 Commands:
   create-commit
   create-report
-  create-report-results
   do-upload
   empty-upload
-  get-report-results
   pr-base-picking
   process-test-results
   send-notifications
@@ -44,8 +42,6 @@ Options:
 Usage: codecovcli create-report [OPTIONS]
 
 Options:
-  --code TEXT                     The code of the report. If unsure, leave
-                                  default
   -P, --pr, --pull-request-number TEXT
                                   Specify the pull request number manually.
                                   Used to override pre-existing CI environment
@@ -58,24 +54,9 @@ Options:
                                   repo token in Self-hosted
   -h, --help                      Show this message and exit.
 
-Usage: codecovcli create-report-results [OPTIONS]
-
-Options:
-  --code TEXT                     The code of the report. If unsure, leave
-                                  default
-  -C, --sha, --commit-sha TEXT    Commit SHA (with 40 chars)  [required]
-  -Z, --fail-on-error             Exit with non-zero code in case of error
-  --git-service [github|gitlab|bitbucket|github_enterprise|gitlab_enterprise|bitbucket_server]
-  -t, --token TEXT                Codecov upload token
-  -r, --slug TEXT                 owner/repo slug used instead of the private
-                                  repo token in Self-hosted
-  -h, --help                      Show this message and exit.
-
 Usage: codecovcli do-upload [OPTIONS]
 
 Options:
-  --code, --report-code TEXT      The code of the report. If unsure, leave
-                                  default
   --network-root-folder PATH      Root folder from which to consider paths on
                                   the network section  [default: (Current
                                   working directory)]
@@ -164,19 +145,6 @@ Options:
                                   repo token in Self-hosted
   -h, --help                      Show this message and exit.
 
-Usage: codecovcli get-report-results [OPTIONS]
-
-Options:
-  --code TEXT                     The code of the report. If unsure, leave
-                                  default
-  -C, --sha, --commit-sha TEXT    Commit SHA (with 40 chars)  [required]
-  -Z, --fail-on-error             Exit with non-zero code in case of error
-  --git-service [github|gitlab|bitbucket|github_enterprise|gitlab_enterprise|bitbucket_server]
-  -t, --token TEXT                Codecov upload token
-  -r, --slug TEXT                 owner/repo slug used instead of the private
-                                  repo token in Self-hosted
-  -h, --help                      Show this message and exit.
-
 Usage: codecovcli pr-base-picking [OPTIONS]
 
 Options:
@@ -230,8 +198,6 @@ Options:
   -t, --token TEXT                Codecov upload token
   -r, --slug TEXT                 owner/repo slug used instead of the private
                                   repo token in Self-hosted
-  --code, --report-code TEXT      The code of the report. If unsure, leave
-                                  default
   --network-root-folder PATH      Root folder from which to consider paths on
                                   the network section  [default: (Current
                                   working directory)]
@@ -306,8 +272,6 @@ Options:
   -t, --token TEXT                Codecov upload token
   -r, --slug TEXT                 owner/repo slug used instead of the private
                                   repo token in Self-hosted
-  --code, --report-code TEXT      The code of the report. If unsure, leave
-                                  default
   --network-root-folder PATH      Root folder from which to consider paths on
                                   the network section  [default: (Current
                                   working directory)]

tests/commands/test_invoke_upload_coverage.py

@@ -75,8 +75,6 @@ def test_upload_coverage_options(mocker):
             "  -t, --token TEXT                Codecov upload token",
             "  -r, --slug TEXT                 owner/repo slug used instead of the private",
             "                                  repo token in Self-hosted",
-            "  --code, --report-code TEXT      The code of the report. If unsure, leave",
-            "                                  default",
             "  --network-root-folder PATH      Root folder from which to consider paths on",
             "                                  the network section  [default: (Current",
             "                                  working directory)]",

tests/commands/test_invoke_upload_process.py

@@ -75,8 +75,6 @@ def test_upload_process_options(mocker):
             "  -t, --token TEXT                Codecov upload token",
             "  -r, --slug TEXT                 owner/repo slug used instead of the private",
             "                                  repo token in Self-hosted",
-            "  --code, --report-code TEXT      The code of the report. If unsure, leave",
-            "                                  default",
             "  --network-root-folder PATH      Root folder from which to consider paths on",
             "                                  the network section  [default: (Current",
             "                                  working directory)]",