Move reportsizetrends code into separate action

This makes maintenance of the compile-examples action a little easier and also makes the documentation more friendly to the users who don't have the need for the size trends report feature.

Author: per1234

.github/workflows/libraries_compile-examples.yml

@@ -28,17 +28,14 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install --requirement "$GITHUB_WORKSPACE/libraries/compile-examples/compilesketches/requirements.txt"
-          pip install --requirement "$GITHUB_WORKSPACE/libraries/compile-examples/reportsizetrends/requirements.txt"
 
       - name: Lint with flake8
         run: |
           pip install --quiet flake8
           pip install --quiet pep8-naming
           flake8 --config "$GITHUB_WORKSPACE/libraries/compile-examples/compilesketches/.flake8" --show-source "$GITHUB_WORKSPACE/libraries/compile-examples/compilesketches"
-          flake8 --config "$GITHUB_WORKSPACE/libraries/compile-examples/reportsizetrends/.flake8" --show-source "$GITHUB_WORKSPACE/libraries/compile-examples/reportsizetrends"
 
       - name: Run Python unit tests
         run: |
-          export PYTHONPATH="$GITHUB_WORKSPACE/libraries/compile-examples/compilesketches:$GITHUB_WORKSPACE/libraries/compile-examples/reportsizetrends"
+          export PYTHONPATH="$GITHUB_WORKSPACE/libraries/compile-examples/compilesketches"
           pytest "$GITHUB_WORKSPACE/libraries/compile-examples/compilesketches/tests"
-          pytest "$GITHUB_WORKSPACE/libraries/compile-examples/reportsizetrends/tests"

Dockerfile

@@ -1,14 +1,10 @@
 FROM python:3.8.2
 
-ENV PYTHONPATH="/reportsizetrends"
-
 # Copies your code file from your action repository to the filesystem path `/` of the container
 COPY compilesketches /compilesketches
-COPY reportsizetrends /reportsizetrends
 
 # Install python dependencies
 RUN pip install -r /compilesketches/requirements.txt
-RUN pip install -r /reportsizetrends/requirements.txt
 
-# Code file to execute when the docker container starts up (`entrypoint.sh`)
+# Code file to execute when the docker container starts up
 ENTRYPOINT ["python", "/compilesketches/compilesketches.py"]

README.md

@@ -107,10 +107,6 @@ List of paths containing sketches to compile. These paths will be searched recur
 
 Set to true to show verbose output in the log. Default `false`
 
-### `github-token`
-
-GitHub access token used to get information from the GitHub API. Only needed if you're using the size report features with private repositories. It will be convenient to use [`${{ secrets.GITHUB_TOKEN }}`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token). Default `""`.
-
 ### `size-report-sketch`
 
 Name of the sketch used to compare memory usage change. Default `""`.
@@ -119,65 +115,14 @@ Name of the sketch used to compare memory usage change. Default `""`.
 
 Path in which to save a JSON formatted file containing data from the sketch compilations. Should be used only to store reports. Relative paths are relative to [`GITHUB_WORKSPACE`](https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables). The folder will be created if it doesn't already exist. This report is used by the `arduino/libraries/report-size-deltas` and `arduino/libraries/report-size-trends` actions. Default `"size-deltas-reports"`.
 
+### `github-token`
+
+GitHub access token used to get information from the GitHub API. Only needed if you're using the size report features with private repositories. It will be convenient to use [`${{ secrets.GITHUB_TOKEN }}`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token). Default `""`.
+
 ### `enable-size-deltas-report`
 
 Set to `true` to cause the action to determine the change in memory usage for the [`size-reports-sketch`](#size-reports-sketch) between the pull request branch and the tip of the pull request's base branch. This may be used with the [`arduino/actions/libraries/report-size-deltas` action](https://github.com/arduino/actions/tree/master/libraries/report-size-deltas). Default `false`.
 
-### `enable-size-trends-report`
-
-Set to `true` to cause the action to record the memory usage of [`size-reports-sketch`](#size-reports-sketch) to a Google Sheets spreadsheet on every push to the repository's default branch. Default `false`.
-
-### `keyfile`
-
-Contents of the Google key file used to update the size trends report Google Sheets spreadsheet. This should be defined using a [GitHub secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets). Default `""`.
-1. Open https://console.developers.google.com/project
-1. Click the "Create Project" button.
-1. In the "Project name" field, enter the name you want for your project.
-1. You don't need to select anything from the "Location" menu.
-1. Click the button with the three horizontal lines at the top left corner of the window.
-1. Hover the mouse pointer over "APIs & Services".
-1. Click "Library".
-1. Make sure the name of the project you created is selected from the dropdown menu at the top of the window.
-1. Click 'Google Sheets API".
-1. Click the "Enable" button.
-1. Click the "Create Credentials" button.
-1. From the "Which API are you using?" menu, select "Google Sheets API".
-1. From the "Where will you be calling the API from?" menu, select "Other non-UI".
-1. From the "What data will you be accessing?" options, select "Application data".
-1. From the "Are you planning to use this API with App Engine or Compute Engine?" options, select "No, I’m not using them".
-1. Click the "What credentials do I need?" button.
-1. In the "Service account name" field, enter the name you want to use for the service account.
-1. From the "Role" menu, select "Project > Editor".
-1. From the "Key type" options, select "JSON".
-1. Click the "Continue" button. The .json file containing your private key will be downloaded. Save this somewhere safe.
-1. Open the downloaded file.
-1. Copy the entire contents of the file to the clipboard.
-1. Open the GitHub page of the repository you are configuring the GitHub Actions workflow for.
-1. Click the "Settings" tab.
-1. From the menu on the left side of the window, click "Secrets".
-1. Click the "Add a new secret" link.
-1. In the "Name" field, enter the variable name you want to use for your secret. This will be used for the `size-trends-report-key-file` argument of the `compile-examples` action in your workflow configuration file. For example, if you named the secret `GOOGLE_KEY_FILE`, you would reference it in your workflow configuration as `${{ secrets.GOOGLE_KEY_FILE }}`.
-1. In the "Value" field, paste the contents of the key file.
-1. Click the "Add secret" button.
-1. Open the downloaded key file again.
-1. Copy the email address shown in the `client_email` field.
-1. Open Google Sheets: https://docs.google.com/spreadsheets
-1. Under "Start a new spreadsheet", click "Blank".
-1. Click the "Share" button at the top right corner of the window.
-1. If you haven't already, give your spreadsheet a name.
-1. Paste the `client_email` email address into the "Enter names or email addresses..." field.
-1. Uncheck the box next to "Notify people".
-1. Click the "OK" button.
-1. In the "Skip sending invitations?" dialog, click the "OK" button.
-
-### `size-trends-report-spreadsheet-id`
-
-The ID of the Google Sheets spreadsheet to write the memory usage trends data to. The URL of your spreadsheet will look something like `https://docs.google.com/spreadsheets/d/15WOp3vp-6AnTnWlNWaNWNl61Fe_j8UJhIKE0rVdV-7U/edit#gid=0`. In this example, the spreadsheet ID is `15WOp3vp-6AnTnWlNWaNWNl61Fe_j8UJhIKE0rVdV-7U`. Default `""`.
-
-### `size-trends-report-sheet-name`
-
-The sheet name in the Google Sheets spreadsheet used for the memory usage trends report. Default `"Sheet1"`.
-
 ## Example usage
 
 Only compiling examples:
@@ -203,13 +148,3 @@ Storing the memory usage change report as a [workflow artifact](https://help.git
     name: size-deltas-reports
     path: size-delta-reports
 ```
-
-Publishing memory usage trends data to a Google Sheets spreadsheet:
-```yaml
-- uses: arduino/actions/libraries/compile-examples@master
-  with:
-    size-report-sketch: Foobar
-    enable-size-trends-report: true
-    keyfile: ${{ secrets.GOOGLE_KEY_FILE }}
-    size-trends-report-spreadsheet-id: 15WOp3vp-6AnTnWlNWaNWNl61Fe_j8UJhIKE0rVdV-7U
-```

action.yml

@@ -19,30 +19,18 @@ inputs:
   verbose:
     description: 'Set to true to show verbose output in the log'
     default: false
-  github-token:
-    description: 'GitHub access token used to get information from the GitHub API. Only needed if you are using the size report features with private repositories.'
-    default: ''
   size-report-sketch:
     description: 'Name of the sketch used to compare memory usage change'
     default: ''
   sketches-report-path:
     description: 'Path in which to save a JSON formatted file containing data from the sketch compilations'
     default: 'size-deltas-reports'
+  github-token:
+    description: 'GitHub access token used to get information from the GitHub API. Only needed if you are using the size deltas report feature with a private repository.'
+    default: ''
   enable-size-deltas-report:
     description: 'Set to true to cause the action to determine the change in memory usage for the size-reports-sketch'
     default: false
-  enable-size-trends-report:
-    description: 'Set to true to cause the action to record the memory usage of size-reports-sketch'
-    default: false
-  keyfile:
-    description: 'Google key file used to update the size trends report Google Sheets spreadsheet.'
-    default: ''
-  size-trends-report-spreadsheet-id:
-    description: 'The ID of the Google Sheets spreadsheet to write the memory usage trends data to'
-    default: ''
-  size-trends-report-sheet-name:
-    description: 'The sheet name in the Google Sheets spreadsheet used for the memory usage trends report'
-    default: 'Sheet1'
 runs:
   using: 'docker'
   image: 'Dockerfile'

compilesketches/compilesketches.py

@@ -18,15 +18,17 @@
 import yaml
 import yaml.parser
 
-import reportsizetrends
-
 
 def main():
     if "INPUT_SIZE-DELTAS-REPORT-FOLDER-NAME" in os.environ:
         print("::warning::The size-deltas-report-folder-name input is deprecated. Use the equivalent input: "
               "sketches-report-path instead.")
         os.environ["INPUT_SKETCHES-REPORT-PATH"] = os.environ["INPUT_SIZE-DELTAS-REPORT-FOLDER-NAME"]
 
+    if "INPUT_ENABLE-SIZE-TRENDS-REPORT" in os.environ:
+        print("::warning::The size trends report feature has been moved to a dedicated action. See the documentation "
+              "at https://github.com/arduino/actions/tree/report-size-trends-action/libraries/report-size-trends")
+
     compile_sketches = CompileSketches(
         cli_version=os.environ["INPUT_CLI-VERSION"],
         fqbn_arg=os.environ["INPUT_FQBN"],
@@ -37,11 +39,7 @@ def main():
         github_token=os.environ["INPUT_GITHUB-TOKEN"],
         report_sketch=os.environ["INPUT_SIZE-REPORT-SKETCH"],
         enable_size_deltas_report=os.environ["INPUT_ENABLE-SIZE-DELTAS-REPORT"],
-        sketches_report_path=os.environ["INPUT_SKETCHES-REPORT-PATH"],
-        enable_size_trends_report=os.environ["INPUT_ENABLE-SIZE-TRENDS-REPORT"],
-        google_key_file=os.environ["INPUT_KEYFILE"],
-        size_trends_report_spreadsheet_id=os.environ["INPUT_SIZE-TRENDS-REPORT-SPREADSHEET-ID"],
-        size_trends_report_sheet_name=os.environ["INPUT_SIZE-TRENDS-REPORT-SHEET-NAME"]
+        sketches_report_path=os.environ["INPUT_SKETCHES-REPORT-PATH"]
     )
 
     compile_sketches.compile_sketches()
@@ -64,13 +62,6 @@ class CompileSketches:
     enable_size_deltas_report -- set to "true" to cause the action to determine the change in memory usage for the
                                  report_sketch ("true", "false")
     sketches_report_path -- folder to save the sketches report to
-    enable_size_trends_report -- whether to record the memory usage of report_sketch
-                                 ("true", "false")
-    google_key_file -- Google key file used to update the size trends report Google Sheets spreadsheet
-    size_trends_report_spreadsheet_id -- the ID of the Google Sheets spreadsheet to write the memory usage trends data
-                                         to
-    size_trends_report_sheet_name -- the sheet name in the Google Sheets spreadsheet used for the memory usage trends
-                                     report
     """
 
     class RunCommandOutput(enum.Enum):
@@ -108,8 +99,7 @@ class RunCommandOutput(enum.Enum):
     latest_release_indicator = "latest"
 
     def __init__(self, cli_version, fqbn_arg, platforms, libraries, sketch_paths, verbose, github_token, report_sketch,
-                 enable_size_deltas_report, sketches_report_path, enable_size_trends_report, google_key_file,
-                 size_trends_report_spreadsheet_id, size_trends_report_sheet_name):
+                 enable_size_deltas_report, sketches_report_path):
         """Process, store, and validate the action's inputs."""
         self.cli_version = cli_version
 
@@ -142,25 +132,7 @@ def __init__(self, cli_version, fqbn_arg, platforms, libraries, sketch_paths, ve
 
         self.sketches_report_path = pathlib.PurePath(sketches_report_path)
 
-        self.enable_size_trends_report = parse_boolean_input(boolean_input=enable_size_trends_report)
-        # The enable-size-trends-report input has a default value so it should always be either True or False
-        if self.enable_size_trends_report is None:
-            print("::error::Invalid value for enable-size-trends-report input")
-            sys.exit(1)
-
-        self.google_key_file = google_key_file
-        if self.enable_size_trends_report and self.google_key_file == "":
-            print("::error::keyfile input was not defined")
-            sys.exit(1)
-
-        self.size_trends_report_spreadsheet_id = size_trends_report_spreadsheet_id
-        if self.enable_size_trends_report and self.size_trends_report_spreadsheet_id == "":
-            print("::error::size-trends-report-spreadsheet-id input was not defined")
-            sys.exit(1)
-
-        self.size_trends_report_sheet_name = size_trends_report_sheet_name
-
-        if (self.enable_size_deltas_report or self.enable_size_trends_report) and self.report_sketch == "":
+        if self.enable_size_deltas_report and self.report_sketch == "":
             print("::error::size-report-sketch input was not defined")
             sys.exit(1)
 
@@ -193,9 +165,6 @@ def compile_sketches(self):
             # TODO: The current behavior is to only write the report for the report sketch, but the plan is to change to
             #       reporting data for all sketches, thus the passing of sketch_report to the function
             self.create_sketches_report_file(sketches_report=sketch_report)
-            # Make the memory usage trends report
-            if self.do_size_trends_report():
-                self.make_size_trends_report()
 
         if not all_compilations_successful:
             print("::error::One or more compilations failed")
@@ -973,32 +942,6 @@ def get_size_deltas(self, current_sketch_report, previous_sketch_report):
 
         return sketch_report
 
-    def do_size_trends_report(self):
-        """Return whether the size trends report is enabled"""
-        return (
-            self.enable_size_trends_report
-            and os.environ["GITHUB_EVENT_NAME"] == "push"
-            and self.is_default_branch()
-        )
-
-    def is_default_branch(self):
-        """Return whether the current branch is the repository's default branch"""
-        current_branch_name = os.environ["GITHUB_REF"].rpartition("/")[2]
-
-        try:
-            default_branch_name = self.github_api.get_repo(os.environ["GITHUB_REPOSITORY"]).default_branch
-        except github.UnknownObjectException:
-            print("::error::Unable to access repository data. Please specify the github-token input in your workflow"
-                  " configuration.")
-            sys.exit(1)
-
-        if current_branch_name != default_branch_name:
-            is_default_branch = False
-        else:
-            is_default_branch = True
-
-        return is_default_branch
-
     def get_sketch_report_from_sketches_report(self, sketches_report):
         """Return the report for the report sketch
 
@@ -1016,23 +959,6 @@ def get_sketch_report_from_sketches_report(self, sketches_report):
         print("::error::size-report-sketch:", self.report_sketch, "was not found")
         sys.exit(1)
 
-    def make_size_trends_report(self):
-        """Publish the size data for the report sketch to a Google Sheets spreadsheet.
-
-        Keyword arguments:
-        sketch_report -- report for the sketch report
-        """
-        self.verbose_print("Making size trends report")
-
-        report_size_trends = reportsizetrends.ReportSizeTrends(
-            sketches_report_path=str(self.sketches_report_path),
-            google_key_file=self.google_key_file,
-            spreadsheet_id=self.size_trends_report_spreadsheet_id,
-            sheet_name=self.size_trends_report_sheet_name
-        )
-
-        report_size_trends.report_size_trends()
-
     def create_sketches_report_file(self, sketches_report):
         """Write the report for the report sketch to a file.