Merge pull request #280 from tekktrik/dev/add-additional-checks

Update docs and CI checks

Author: kattni

.github/workflows/reports_cron.yml

@@ -29,6 +29,7 @@ jobs:
     env:
       ADABOT_GITHUB_USER: ${{ secrets.ADABOT_GITHUB_USER }}
       ADABOT_GITHUB_ACCESS_TOKEN: ${{ secrets.ADABOT_GITHUB_ACCESS_TOKEN }}
+      RTD_TOKEN: ${{ secrets.RTD_TOKEN }}
     steps:
       - name: Dump GitHub context
         env:

adabot/arduino_libraries.py

@@ -11,7 +11,7 @@
 
 import requests
 
-from adabot import github_requests as github
+from adabot import github_requests as gh_reqs
 
 logger = logging.getLogger(__name__)
 ch = logging.StreamHandler(stream=sys.stdout)
@@ -50,7 +50,7 @@ def list_repos():
     repository state.
     """
     repos = []
-    result = github.get(
+    result = gh_reqs.get(
         "/search/repositories",
         params={
             "q": (
@@ -70,7 +70,7 @@ def list_repos():
         )  # uncomment and comment below, to include all forks
 
         if result.links.get("next"):
-            result = github.get(result.links["next"]["url"])
+            result = gh_reqs.get(result.links["next"]["url"])
         else:
             break
 
@@ -124,7 +124,7 @@ def validate_library_properties(repo):
             lib_version = line[len("version=") :]
             break
 
-    get_latest_release = github.get(
+    get_latest_release = gh_reqs.get(
         "/repos/adafruit/" + repo["name"] + "/releases/latest"
     )
     if get_latest_release.ok:
@@ -151,7 +151,7 @@ def validate_release_state(repo):
     if not is_arduino_library(repo):
         return None
 
-    compare_tags = github.get(
+    compare_tags = gh_reqs.get(
         "/repos/" + repo["full_name"] + "/compare/master..." + repo["tag_name"]
     )
     if not compare_tags.ok:
@@ -187,7 +187,7 @@ def validate_actions(repo):
 
 def validate_example(repo):
     """Validate if a repo has any files in examples directory"""
-    repo_has_ino = github.get("/repos/adafruit/" + repo["name"] + "/contents/examples")
+    repo_has_ino = gh_reqs.get("/repos/adafruit/" + repo["name"] + "/contents/examples")
     return repo_has_ino.ok and len(repo_has_ino.json())
 
 

adabot/circuitpython_bundle.py

@@ -18,7 +18,7 @@
 import sh
 from sh.contrib import git
 
-from adabot import github_requests as github
+from adabot import github_requests as gh_reqs
 from adabot.lib import common_funcs
 
 REDIS = None
@@ -284,7 +284,7 @@ def get_contributors(repo, commit_range):
         author = REDIS.get("github_username:" + author_email)
         committer = REDIS.get("github_username:" + committer_email)
         if not author or not committer:
-            github_commit_info = github.get("/repos/" + repo + "/commits/" + sha)
+            github_commit_info = gh_reqs.get("/repos/" + repo + "/commits/" + sha)
             github_commit_info = github_commit_info.json()
             if github_commit_info["author"]:
                 author = github_commit_info["author"]["login"]
@@ -332,7 +332,7 @@ def new_release(bundle, bundle_path):
     working_directory = os.path.abspath(os.getcwd())
     os.chdir(bundle_path)
     print(bundle)
-    current_release = github.get("/repos/adafruit/{}/releases/latest".format(bundle))
+    current_release = gh_reqs.get("/repos/adafruit/{}/releases/latest".format(bundle))
     last_tag = current_release.json()["tag_name"]
     contributors = get_contributors("adafruit/" + bundle, last_tag + "..")
     added_submodules = []
@@ -430,7 +430,7 @@ def new_release(bundle, bundle_path):
 
     print("Releasing {}".format(release["tag_name"]))
     print(release["body"])
-    response = github.post("/repos/adafruit/" + bundle + "/releases", json=release)
+    response = gh_reqs.post("/repos/adafruit/" + bundle + "/releases", json=release)
     if not response.ok:
         print("Failed to create release")
         print(release)

adabot/circuitpython_libraries.py

@@ -13,7 +13,7 @@
 import sys
 import traceback
 
-from adabot import github_requests as github
+from adabot import github_requests as gh_reqs
 from adabot import pypi_requests as pypi
 from adabot.lib import circuitpython_library_validators as cirpy_lib_vals
 from adabot.lib import common_funcs
@@ -307,7 +307,7 @@ def print_circuitpython_dl_stats():
     #       enable this.
 
     try:
-        response = github.get("/repos/adafruit/circuitpython/releases")
+        response = gh_reqs.get("/repos/adafruit/circuitpython/releases")
     except (ValueError, RuntimeError):
         logger.info("Core CircuitPython GitHub download statistics request failed.")
         return

adabot/circuitpython_library_download_stats.py

@@ -13,7 +13,7 @@
 import operator
 import requests
 
-from adabot import github_requests as github
+from adabot import github_requests as gh_reqs
 from adabot.lib import common_funcs
 
 # Setup ArgumentParser
@@ -107,7 +107,7 @@ def get_bundle_stats(bundle):
     that tag name(s) will be the date (YYYYMMDD).
     """
     stats_dict = {}
-    bundle_stats = github.get("/repos/adafruit/" + bundle + "/releases")
+    bundle_stats = gh_reqs.get("/repos/adafruit/" + bundle + "/releases")
     if not bundle_stats.ok:
         return {"Failed to retrieve bundle stats": bundle_stats.text}
     start_date = datetime.date.today()

adabot/lib/assign_hacktober_label.py

@@ -11,7 +11,7 @@
 import datetime
 import requests
 
-from adabot import github_requests as github
+from adabot import github_requests as gh_reqs
 from adabot.lib import common_funcs
 
 cli_args = argparse.ArgumentParser(description="Hacktoberfest Label Assigner")
@@ -61,7 +61,7 @@ def get_open_issues(repo):
     params = {
         "state": "open",
     }
-    response = github.get("/repos/" + repo["full_name"] + "/issues", params=params)
+    response = gh_reqs.get("/repos/" + repo["full_name"] + "/issues", params=params)
     if not response.ok:
         print(f"Failed to retrieve issues for '{repo['name']}'")
         return False
@@ -84,7 +84,7 @@ def ensure_hacktober_label_exists(repo, dry_run=False):
     """Checks if the 'Hacktoberfest' label exists on the repo.
     If not, creates the label.
     """
-    response = github.get(f"/repos/{repo['full_name']}/labels")
+    response = gh_reqs.get(f"/repos/{repo['full_name']}/labels")
     if not response.ok:
         print(f"Failed to retrieve labels for '{repo['name']}'")
         return False
@@ -99,7 +99,7 @@ def ensure_hacktober_label_exists(repo, dry_run=False):
             "description": "DigitalOcean's Hacktoberfest",
         }
         if not dry_run:
-            result = github.post(f"/repos/{repo['full_name']}/labels", json=params)
+            result = gh_reqs.post(f"/repos/{repo['full_name']}/labels", json=params)
             if not result.status_code == 201:
                 print(f"Failed to create new Hacktoberfest label for: {repo['name']}")
                 return False
@@ -139,7 +139,7 @@ def assign_hacktoberfest(repo, issues=None, remove_labels=False, dry_run=False):
             label_names.append("Hacktoberfest")
             params = {"labels": label_names}
             if not dry_run:
-                result = github.patch(
+                result = gh_reqs.patch(
                     f"/repos/{repo['full_name']}/issues/{str(issue['number'])}",
                     json=params,
                 )

adabot/lib/blinka_funcs.py

@@ -4,7 +4,7 @@
 
 """Common functions used with Adabot & Blinka interactions."""
 
-from adabot import github_requests as github
+from adabot import github_requests as gh_reqs
 
 
 def board_count():
@@ -13,7 +13,7 @@ def board_count():
     """
     count = 0
     cirpy_org_url = "/repos/adafruit/circuitpython-org/contents/_blinka"
-    response = github.get(cirpy_org_url)
+    response = gh_reqs.get(cirpy_org_url)
     if response.ok:
         response_json = response.json()
         count = len(response_json)