cumulusci 3.68.0.dev2__tar.gz → 3.69.0__tar.gz

{cumulusci-3.68.0.dev2 → cumulusci-3.69.0}/HISTORY.rst

@@ -2,6 +2,58 @@
 History
 =======
 
+3.69 (2022-11-14)
+-----------------
+
+Changes 🎉
+
+-  Added support for debugging and breakpoints in Playwright-based
+   Robot Framework by @boakley in
+   https://github.com/SFDO-Tooling/CumulusCI/pull/3408
+-  Added option for deploy task to remove selected components from the
+   bundle by 
+   @jkasturi-sf in https://github.com/SFDO-Tooling/CumulusCI/pull/3421
+-  Added documentation for using OmniStudio in Cumulus flows by @bethbrains in
+   https://github.com/SFDO-Tooling/CumulusCI/pull/3427
+-  Update creation of OmniStudio Remote Site Settings for new
+   Salesforce domain patterns (e.g. .\*scratch.my.salesforce,
+   \*.demo.my.salesforce, etc.) by
+   syntaxes (e.g. .*scratch.my.salesforce, \*.demo.my.salesforce, etc.)
+   by @jofsky in https://github.com/SFDO-Tooling/CumulusCI/pull/3424
+-  The deploy_marketing_cloud_package task will now output the
+   constructed payload sent to Marketing Cloud when the --debug flag is
+   passed. by @TheBitShepherd in
+   https://github.com/SFDO-Tooling/CumulusCI/pull/3430
+
+3.68.1 (2022-11-01)
+-------------------
+Critical Changes 🎉
+
+- Revert a change in parsing config files which was incompatible with some configs
+
+3.68.0 (2022-10-31)
+-------------------
+
+Critical Changes 🎉
+
+-  Upgraded Robot Framework from version 4.1.3 to version 6. As with most Robot Framework updates, there are a host of new features and a few deprecated features and backwards incompatibilities. For a complete list consult the `Robot Framework release notes <https://github.com/robotframework/robotframework/releases>`__ in https://github.com/SFDO-Tooling/CumulusCI/pull/3417
+
+Changes 🎉
+
+-  Add support for InstallKey, sourceOrg, release keys on 2GP version create by @davidmreed in https://github.com/SFDO-Tooling/CumulusCI/pull/3403
+-  We now support the ``Territory2``, ``Territory2Model``, ``Territory2Type``, and ``Territory2Rule`` MetaData types. by @TheBitShepherd in https://github.com/SFDO-Tooling/CumulusCI/pull/3406
+-  Add ``push_upgrade_org`` flow to test in simulated push upgrade environment by @davidmreed in https://github.com/SFDO-Tooling/CumulusCI/pull/3286
+-  Fixed bug preventing the ``deploy_omni_studio_site_settings`` task from deploying to scratch orgs with the new ``.scratch.`` domain names by @jofsky in https://github.com/SFDO-Tooling/CumulusCI/pull/3411
+-  All new keychain details are serialized using JSON, not pickle by @bethbrains in https://github.com/SFDO-Tooling/CumulusCI/pull/3390
+- Snowfakery (upgraded to 3.4) can now generate Event or Meeting Schedules similar to Calendar Apps
+- Snowfakery now has a Salesforce.ContentFile feature for generating Content Versions
+
+Issues Fixed 🩴
+
+-  Bumped key_size from 2048 to 4096 on advice from a security audit by @boakley in https://github.com/SFDO-Tooling/CumulusCI/pull/3389
+-  Fixed an issue where unknown deploy statuses could cause polling to hang in the deploy_marketing_cloud_package task by @TheBitShepherd in https://github.com/SFDO-Tooling/CumulusCI/pull/3394
+-  Fixed an injection vulnerability related to unquoted csv writers by @TheBitShepherd in https://github.com/SFDO-Tooling/CumulusCI/pull/3404
+
 3.66.0 (2022-09-29)
 -------------------
 

{cumulusci-3.68.0.dev2 → cumulusci-3.69.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cumulusci
-Version: 3.68.0.dev2
+Version: 3.69.0
 Summary: Build and release tools for Salesforce developers
 Home-page: https://github.com/SFDO-Tooling/CumulusCI
 Author: Salesforce.org
@@ -66,6 +66,58 @@ Description: =========
         History
         =======
         
+        3.69 (2022-11-14)
+        -----------------
+        
+        Changes 🎉
+        
+        -  Added support for debugging and breakpoints in Playwright-based
+           Robot Framework by @boakley in
+           https://github.com/SFDO-Tooling/CumulusCI/pull/3408
+        -  Added option for deploy task to remove selected components from the
+           bundle by 
+           @jkasturi-sf in https://github.com/SFDO-Tooling/CumulusCI/pull/3421
+        -  Added documentation for using OmniStudio in Cumulus flows by @bethbrains in
+           https://github.com/SFDO-Tooling/CumulusCI/pull/3427
+        -  Update creation of OmniStudio Remote Site Settings for new
+           Salesforce domain patterns (e.g. .\*scratch.my.salesforce,
+           \*.demo.my.salesforce, etc.) by
+           syntaxes (e.g. .*scratch.my.salesforce, \*.demo.my.salesforce, etc.)
+           by @jofsky in https://github.com/SFDO-Tooling/CumulusCI/pull/3424
+        -  The deploy_marketing_cloud_package task will now output the
+           constructed payload sent to Marketing Cloud when the --debug flag is
+           passed. by @TheBitShepherd in
+           https://github.com/SFDO-Tooling/CumulusCI/pull/3430
+        
+        3.68.1 (2022-11-01)
+        -------------------
+        Critical Changes 🎉
+        
+        - Revert a change in parsing config files which was incompatible with some configs
+        
+        3.68.0 (2022-10-31)
+        -------------------
+        
+        Critical Changes 🎉
+        
+        -  Upgraded Robot Framework from version 4.1.3 to version 6. As with most Robot Framework updates, there are a host of new features and a few deprecated features and backwards incompatibilities. For a complete list consult the `Robot Framework release notes <https://github.com/robotframework/robotframework/releases>`__ in https://github.com/SFDO-Tooling/CumulusCI/pull/3417
+        
+        Changes 🎉
+        
+        -  Add support for InstallKey, sourceOrg, release keys on 2GP version create by @davidmreed in https://github.com/SFDO-Tooling/CumulusCI/pull/3403
+        -  We now support the ``Territory2``, ``Territory2Model``, ``Territory2Type``, and ``Territory2Rule`` MetaData types. by @TheBitShepherd in https://github.com/SFDO-Tooling/CumulusCI/pull/3406
+        -  Add ``push_upgrade_org`` flow to test in simulated push upgrade environment by @davidmreed in https://github.com/SFDO-Tooling/CumulusCI/pull/3286
+        -  Fixed bug preventing the ``deploy_omni_studio_site_settings`` task from deploying to scratch orgs with the new ``.scratch.`` domain names by @jofsky in https://github.com/SFDO-Tooling/CumulusCI/pull/3411
+        -  All new keychain details are serialized using JSON, not pickle by @bethbrains in https://github.com/SFDO-Tooling/CumulusCI/pull/3390
+        - Snowfakery (upgraded to 3.4) can now generate Event or Meeting Schedules similar to Calendar Apps
+        - Snowfakery now has a Salesforce.ContentFile feature for generating Content Versions
+        
+        Issues Fixed 🩴
+        
+        -  Bumped key_size from 2048 to 4096 on advice from a security audit by @boakley in https://github.com/SFDO-Tooling/CumulusCI/pull/3389
+        -  Fixed an issue where unknown deploy statuses could cause polling to hang in the deploy_marketing_cloud_package task by @TheBitShepherd in https://github.com/SFDO-Tooling/CumulusCI/pull/3394
+        -  Fixed an injection vulnerability related to unquoted csv writers by @TheBitShepherd in https://github.com/SFDO-Tooling/CumulusCI/pull/3404
+        
         3.66.0 (2022-09-29)
         -------------------
         

{cumulusci-3.68.0.dev2 → cumulusci-3.69.0}/cumulusci/core/config/base_config.py

@@ -1,8 +1,8 @@
 import logging
 import os
-import typing as T
 import warnings
 from functools import lru_cache
+from typing import Any, Dict, Optional
 
 # turn on strictness.
 # delete this when strictness is mandatory
@@ -15,8 +15,9 @@ class BaseConfig(object):
 
     defaults = {}
     config: dict
+    logger: logging.Logger
 
-    def __init__(self, config=None, keychain=None):
+    def __init__(self, config: Optional[dict] = None, keychain=None):
         if config is None:
             self.config = {}
         else:
@@ -44,11 +45,11 @@ class BaseConfig(object):
         pass
 
     @classmethod
-    def _allowed_names(cls) -> T.Dict[str, type]:
+    def _allowed_names(cls) -> Dict[str, type]:
         return getattr(cls, "__annotations__", {})
 
     # long term plan is to get rid of this
-    def __getattr__(self, name):
+    def __getattr__(self, name: str) -> Any:
         """Look up a property in a sub-dictionary
 
         Property names should be declared in each Config class with type annotations.
@@ -70,10 +71,10 @@ class BaseConfig(object):
 
     @classmethod
     @lru_cache
-    def _all_allowed_names(cls):
+    def _all_allowed_names(cls) -> Dict[str, type]:
         "Allowed names from this class and its base classes"
         allowed_names_from_all_base_classes = (
-            baseclass._allowed_names()
+            baseclass._allowed_names()  # type: ignore
             for baseclass in cls.__mro__
             if hasattr(baseclass, "_allowed_names")
         )
@@ -82,11 +83,13 @@ class BaseConfig(object):
             ret.update(d)
         return ret
 
-    def lookup(self, name, default=None, already_called_getattr=False):
+    def lookup(
+        self, name: str, default: Any = None, already_called_getattr: bool = False
+    ) -> Any:
         tree = name.split("__")
         if name.startswith("_"):
             raise AttributeError(f"Attribute {name} not found")
-        value = None
+        value: Any = None
         value_found = False
         config = self.config
         if len(tree) > 1:

{cumulusci-3.68.0.dev2 → cumulusci-3.69.0}/cumulusci/core/config/project_config.py

@@ -8,8 +8,9 @@ from distutils.version import LooseVersion
 from io import StringIO
 from itertools import chain
 from pathlib import Path
-from typing import Optional, Union
+from typing import TYPE_CHECKING, Any, Dict, Iterable, Optional, Union
 
+from github3 import GitHub
 from github3.repos.repo import Repository
 
 from cumulusci.core.config.base_config import BaseConfig
@@ -20,7 +21,8 @@ API_VERSION_RE = re.compile(r"^\d\d+\.0$")
 import github3
 from pydantic import ValidationError
 
-from cumulusci.core.config import BaseTaskFlowConfig
+from cumulusci.core.config import FlowConfig, TaskConfig
+from cumulusci.core.config.base_task_flow_config import BaseTaskFlowConfig
 from cumulusci.core.exceptions import (
     ConfigError,
     GithubException,
@@ -36,7 +38,7 @@ from cumulusci.core.github import (
 )
 from cumulusci.core.source import GitHubSource, LocalFolderSource, NullSource
 from cumulusci.core.utils import merge_config
-from cumulusci.utils.fileutils import open_fs_resource
+from cumulusci.utils.fileutils import FSResource, open_fs_resource
 from cumulusci.utils.git import current_branch, git_path, parse_repo_url, split_repo_url
 from cumulusci.utils.yaml.cumulusci_yml import (
     GitHubSourceModel,
@@ -44,6 +46,10 @@ from cumulusci.utils.yaml.cumulusci_yml import (
     cci_safe_load,
 )
 
+if TYPE_CHECKING:
+    from cumulusci.core.config.universal_config import UniversalConfig
+    from cumulusci.core.keychain.base_project_keychain import BaseProjectKeychain
+
 
 class ProjectConfigPropertiesMixin(BaseConfig):
     """Mixin for shared properties used by ProjectConfigs and UniversalConfigs"""
@@ -65,9 +71,26 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
     """Base class for a project's configuration which extends the global config"""
 
     config_filename = "cumulusci.yml"
+    universal_config_obj: "UniversalConfig"
+    keychain: Optional["BaseProjectKeychain"]
+    _repo_info: Dict[str, Any]
+    config_project: dict
+    config_project_local: dict
+    config_additional_yaml: dict
+    additional_yaml: Optional[str]
+    source: Union[NullSource, GitHubSource, LocalFolderSource]
+    _cache_dir: Optional[Path]
+    included_sources: Dict[
+        Union[GitHubSourceModel, LocalFolderSourceModel], "BaseProjectConfig"
+    ]
 
     def __init__(
-        self, universal_config_obj, config=None, cache_dir=None, *args, **kwargs
+        self,
+        universal_config_obj: "UniversalConfig",
+        config: Optional[dict] = None,
+        cache_dir: Optional[Path] = None,
+        *args,
+        **kwargs,
     ):
         self.universal_config_obj = universal_config_obj
         self.keychain = None
@@ -85,6 +108,8 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
 
         # optionally pass in a kwarg named 'additional_yaml' that will
         # be added to the YAML merge stack.
+        # Called from MetaCI in metaci/cumulusci/config.py
+        # https://github.com/SFDO-Tooling/MetaCI/blob/36a0f4654/metaci/cumulusci/config.py#L8-L11
         self.additional_yaml = None
         if "additional_yaml" in kwargs:
             self.additional_yaml = kwargs.pop("additional_yaml")
@@ -96,10 +121,10 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
         # Store requested cache directory, which may be our parent's if we are a subproject
         self._cache_dir = cache_dir
 
-        super(BaseProjectConfig, self).__init__(config=config)
+        super().__init__(config=config)
 
     @property
-    def config_project_local_path(self):
+    def config_project_local_path(self) -> Optional[str]:
         path = Path(self.project_local_dir) / self.config_filename
         if path.is_file():
             return str(path)
@@ -175,20 +200,20 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
             raise ConfigError(message)
 
     @property
-    def config_global(self):
+    def config_global(self) -> dict:
         return self.universal_config_obj.config_global
 
     @property
-    def config_universal(self):
+    def config_universal(self) -> dict:
         return self.universal_config_obj.config_universal
 
     @property
-    def repo_info(self):
+    def repo_info(self) -> Dict[str, Any]:
         if self._repo_info is not None:
             return self._repo_info
 
         # Detect if we are running in a CI environment and get repo info
-        # from env vars for the enviornment instead of .git files
+        # from env vars for the environment instead of .git files
         info = {"ci": None}
 
         # Make sure that the CUMULUSCI_AUTO_DETECT environment variable is
@@ -220,7 +245,7 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
         self._repo_info = info
         return self._repo_info
 
-    def _apply_repo_env_var_overrides(self, info):
+    def _apply_repo_env_var_overrides(self, info: Dict[str, Any]):
         """Apply CUMULUSCI_REPO_* environment variables last so they can
         override and fill in missing values from the CI environment"""
         self._override_repo_env_var("CUMULUSCI_REPO_BRANCH", "branch", info)
@@ -239,14 +264,18 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
             url_info["url"] = repo_url
             info.update(url_info)
 
-    def _override_repo_env_var(self, repo_env_var, local_var, info):
-        repo_env_var = os.environ.get(repo_env_var)
-        if repo_env_var:
-            if repo_env_var != info.get(local_var):
-                self.logger.info("{} found, using its value for configuration.")
-            info[local_var] = repo_env_var
+    def _override_repo_env_var(
+        self, repo_env_var: str, local_var: str, info: Dict[str, Any]
+    ):
+        env_value: Optional[str] = os.environ.get(repo_env_var)
+        if env_value:
+            if env_value != info.get(local_var):
+                self.logger.info(
+                    f"{repo_env_var} found, using its value for configuration."
+                )
+            info[local_var] = env_value
 
-    def _validate_required_git_info(self, info):
+    def _validate_required_git_info(self, info: Dict[str, Any]):
         """Ensures that we have the required git info or throw a ConfigError"""
         validate = {
             # <key>: <env var to manually override>
@@ -265,7 +294,7 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
                     message += f" with the {env_var} environment variable."
                 raise ConfigError(message)
 
-    def _log_detected_overrides_as_warning(self, info):
+    def _log_detected_overrides_as_warning(self, info: Dict[str, Any]):
         self.logger.info("")
         self.logger.warning("Using environment variables to override repo info:")
         keys = list(info.keys())
@@ -274,7 +303,7 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
             self.logger.warning(f"  {key}: {info[key]}")
         self.logger.info("")
 
-    def git_config_remote_origin_url(self):
+    def git_config_remote_origin_url(self) -> Optional[str]:
         """Returns the url under the [remote origin]
         section of the .git/config file. Returns None
         if .git/config file not present or no matching
@@ -288,7 +317,7 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
         return url
 
     @property
-    def repo_root(self):
+    def repo_root(self) -> Optional[str]:
         path = self.repo_info.get("root")
         if path:
             return path
@@ -314,7 +343,7 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
             return parse_repo_url(url_line)[2]
 
     @property
-    def repo_name(self):
+    def repo_name(self) -> Optional[str]:
         name = self.repo_info.get("name")
         if name:
             return name
@@ -327,7 +356,7 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
             return split_repo_url(url_line)[1]
 
     @property
-    def repo_url(self):
+    def repo_url(self) -> Optional[str]:
         url = self.repo_info.get("url")
         if url:
             return url
@@ -339,7 +368,7 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
         return url
 
     @property
-    def repo_owner(self):
+    def repo_owner(self) -> Optional[str]:
         owner = self.repo_info.get("owner")
         if owner:
             return owner
@@ -353,7 +382,7 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
             return split_repo_url(url_line)[0]
 
     @property
-    def repo_branch(self):
+    def repo_branch(self) -> Optional[str]:
         branch = self.repo_info.get("branch")
         if branch:
             return branch
@@ -364,7 +393,7 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
         return current_branch(self.repo_root)
 
     @property
-    def repo_commit(self):
+    def repo_commit(self) -> Optional[str]:
         commit = self.repo_info.get("commit")
         if commit:
             return commit
@@ -398,10 +427,10 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
                         ):
                             return parts[0]
 
-    def get_github_api(self, url=None):
+    def get_github_api(self, url: Optional[str] = None) -> GitHub:
         return get_github_api_for_repo(self.keychain, url or self.repo_url)
 
-    def get_repo(self):
+    def get_repo(self) -> Repository:
         repo = self.get_github_api(self.repo_url).repository(
             self.repo_owner, self.repo_name
         )
@@ -412,7 +441,7 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
         return repo
 
     # TODO: These methods are duplicative with `find_latest_release()`
-    def get_latest_tag(self, beta=False):
+    def get_latest_tag(self, beta: bool = False) -> str:
         """Query Github Releases to find the latest production or beta tag"""
         repo = self.get_repo()
         if not beta:
@@ -427,7 +456,7 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
         else:
             return self._get_latest_tag_for_prefix(repo, self.project__git__prefix_beta)
 
-    def _get_latest_tag_for_prefix(self, repo, prefix):
+    def _get_latest_tag_for_prefix(self, repo: Repository, prefix: str) -> str:
         for release in repo.releases():
             if not release.tag_name.startswith(prefix):
                 continue
@@ -436,14 +465,14 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
             f"No release found for {self.repo_url} with tag prefix {prefix}"
         )
 
-    def get_latest_version(self, beta=False):
+    def get_latest_version(self, beta: bool = False) -> Optional[LooseVersion]:
         """Query Github Releases to find the latest production or beta release"""
         tag = self.get_latest_tag(beta)
         version = self.get_version_for_tag(tag)
         if version is not None:
             return LooseVersion(version)
 
-    def get_previous_version(self):
+    def get_previous_version(self) -> Optional[LooseVersion]:
         """Query GitHub releases to find the previous production release"""
         repo = self.get_repo()
         release = find_previous_release(repo, self.project__git__prefix_release)
@@ -451,7 +480,7 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
             return LooseVersion(self.get_version_for_tag(release.tag_name))
 
     @property
-    def config_project_path(self):
+    def config_project_path(self) -> Optional[str]:
         if not self.repo_root:
             return
         path = Path(self.repo_root) / self.config_filename
@@ -459,7 +488,7 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
             return str(path)
 
     @property
-    def project_local_dir(self):
+    def project_local_dir(self) -> str:
         """location of the user local directory for the project
         e.g., ~/.cumulusci/NPSP-Extension-Test/"""
 
@@ -476,7 +505,7 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
         return path
 
     @property
-    def default_package_path(self):
+    def default_package_path(self) -> Path:
         if self.project__source_format == "sfdx":
             relpath = "force-app"
             for pkg in self.sfdx_project_config.get("packageDirectories", []):
@@ -487,21 +516,26 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
         return Path(self.repo_root, relpath).resolve()
 
     @property
-    def sfdx_project_config(self):
+    def sfdx_project_config(self) -> Dict[str, Any]:
         with open(
             Path(self.repo_root) / "sfdx-project.json", "r", encoding="utf-8"
         ) as f:
             config = json.load(f)
         return config
 
-    def get_tag_for_version(self, prefix, version):
+    def get_tag_for_version(self, prefix: str, version: str) -> str:
         """Given a prefix and version, returns the appropriate tag name to use."""
         try:
             return PackageVersionNumber.parse(version).format_tag(prefix)
         except ValueError:
             return f"{prefix}{version}"
 
-    def get_version_for_tag(self, tag, prefix_beta=None, prefix_release=None):
+    def get_version_for_tag(
+        self,
+        tag: str,
+        prefix_beta: Optional[str] = None,
+        prefix_release: Optional[str] = None,
+    ) -> Optional[str]:
         try:
             return PackageVersionNumber.parse_tag(
                 tag,
@@ -511,7 +545,7 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
         except ValueError:
             pass
 
-    def set_keychain(self, keychain):
+    def set_keychain(self, keychain: "BaseProjectKeychain"):
         self.keychain = keychain
 
     def _check_keychain(self):
@@ -522,11 +556,11 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
             )
 
     @catch_common_github_auth_errors
-    def get_repo_from_url(self, url) -> Optional[Repository]:
+    def get_repo_from_url(self, url: str) -> Optional[Repository]:
         owner, name = split_repo_url(url)
         return self.get_github_api(url).repository(owner, name)
 
-    def get_task(self, name):
+    def get_task(self, name: str) -> TaskConfig:
         """Get a TaskConfig by task name
 
         If the name has a colon, look for it in a different project config.
@@ -541,7 +575,7 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
             task_config.project_config = self
         return task_config
 
-    def get_flow(self, name):
+    def get_flow(self, name) -> FlowConfig:
         """Get a FlowConfig by flow name
 
         If the name has a colon, look for it in a different project config.
@@ -558,7 +592,7 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
             flow_config.project_config = self
         return flow_config
 
-    def get_namespace(self, ns: str):
+    def get_namespace(self, ns: str) -> "BaseProjectConfig":
         """Look up another project config by its name in the `sources` config.
 
         Also makes sure the project has been fetched, if it's from an external source.
@@ -571,7 +605,7 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
 
     def include_source(
         self, spec: Union[GitHubSourceModel, LocalFolderSourceModel, dict]
-    ):
+    ) -> "BaseProjectConfig":
         """Make sure a project has been fetched from its source.
 
         This either fetches the project code and constructs its project config,
@@ -609,7 +643,7 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
 
         return project_config
 
-    def construct_subproject_config(self, **kwargs):
+    def construct_subproject_config(self, **kwargs) -> "BaseProjectConfig":
         """Construct another project config for an external source"""
         return self.__class__(
             self.universal_config_obj,
@@ -618,12 +652,12 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
             **kwargs,
         )
 
-    def relpath(self, path):
+    def relpath(self, path: str) -> str:
         """Convert path to be relative to the project repo root."""
         return os.path.relpath(os.path.join(self.repo_root, path))
 
     @property
-    def cache_dir(self):
+    def cache_dir(self) -> Path:
         "A project cache which is on the local filesystem. Prefer open_cache where possible."
         if self._cache_dir:
             return self._cache_dir
@@ -635,7 +669,7 @@ class BaseProjectConfig(BaseTaskFlowConfig, ProjectConfigPropertiesMixin):
         return cache_dir
 
     @contextmanager
-    def open_cache(self, cache_name):
+    def open_cache(self, cache_name: str) -> Iterable[FSResource]:
         "A context managed PyFilesystem-based cache which could theoretically be on any filesystem."
         with open_fs_resource(self.cache_dir / cache_name) as cache_dir:
             cache_dir.mkdir(exist_ok=True, parents=True)

{cumulusci-3.68.0.dev2 → cumulusci-3.69.0}/cumulusci/core/github.py

@@ -108,7 +108,7 @@ def _determine_github_client(host: str, client_params: dict) -> GitHub:
     return client_cls(**params)
 
 
-def get_github_api_for_repo(keychain, repo_url, session=None):
+def get_github_api_for_repo(keychain, repo_url, session=None) -> GitHub:
     owner, repo_name, host = parse_repo_url(repo_url)
     gh: GitHub = _determine_github_client(
         host,