cumulusci 3.61.0.dev1__tar.gz → 3.61.0.dev3__tar.gz

{cumulusci-3.61.0.dev1 → cumulusci-3.61.0.dev3}/AUTHORS.rst

@@ -35,3 +35,4 @@ For example:
 (add your name here, when you contribute through a Pull Request!)
 
 * Ed Rivas (jerivas)
+* Gustavo Tandeciarz (dcinzona)

{cumulusci-3.61.0.dev1 → cumulusci-3.61.0.dev3}/HISTORY.rst

@@ -2047,8 +2047,7 @@ New features:
 * Python 3.8 is now officially supported.
 
 * Flows can now include tasks or flows from a different project.
-  See `Using Tasks and Flows from a Different Project
-  <https://cumulusci.readthedocs.io/en/latest/features.html>`_ for details.
+  See [](tasks-and-flows-from-a-different-project) for details.
 
 * In the ``metadeploy_publish`` task it is now possible to specify a
   commit hash with ``-o commit [sha]``, instead of a tag. This is useful

{cumulusci-3.61.0.dev1 → cumulusci-3.61.0.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cumulusci
-Version: 3.61.0.dev1
+Version: 3.61.0.dev3
 Summary: Build and release tools for Salesforce developers
 Home-page: https://github.com/SFDO-Tooling/CumulusCI
 Author: Salesforce.org
@@ -2111,8 +2111,7 @@ Description: =========
         * Python 3.8 is now officially supported.
         
         * Flows can now include tasks or flows from a different project.
-          See `Using Tasks and Flows from a Different Project
-          <https://cumulusci.readthedocs.io/en/latest/features.html>`_ for details.
+          See [](tasks-and-flows-from-a-different-project) for details.
         
         * In the ``metadeploy_publish`` task it is now possible to specify a
           commit hash with ``-o commit [sha]``, instead of a tag. This is useful

{cumulusci-3.61.0.dev1 → cumulusci-3.61.0.dev3}/cumulusci/cli/tests/test_flow.py

@@ -124,7 +124,7 @@ def test_flow_doc__with_flows_rst_file(load_yaml_data, echo):
         "Flow Reference\n==========================================\n\nopening blurb for flow reference doc\n\n",
         "Group1\n------",
         "This is a description of group1.",
-        "Flow1\n^^^^^\n\n**Description:** Description of Flow1\n\nSome ``extra`` **pizzaz**!\n**Flow Steps**\n\n.. code-block:: console\n",
+        ".. _Flow1:\n\nFlow1\n^^^^^\n\n**Description:** Description of Flow1\n\nSome ``extra`` **pizzaz**!\n**Flow Steps**\n\n.. code-block:: console\n",
         "",
     ]
     expected_call_args = [mock.call(s) for s in expected_call_args]

{cumulusci-3.61.0.dev1 → cumulusci-3.61.0.dev3}/cumulusci/cumulusci.yml

@@ -1262,6 +1262,8 @@ flows:
                     resolution_strategy: unlocked
                     org_dependent: True
                     force_upload: True
+                    post_install_script: null
+                    uninstall_script: null
             3:
                 task: promote_package_version
                 options:

{cumulusci-3.61.0.dev1 → cumulusci-3.61.0.dev3}/cumulusci/salesforce_api/package_zip.py

@@ -307,8 +307,8 @@ class MetadataPackageZipBuilder(BasePackageZipBuilder):
             Package = metadata_tree.parse(package_xml)
             for mdtype in (
                 "FeatureParameterInteger",
-                "FeatureParameterString",
                 "FeatureParameterBoolean",
+                "FeatureParameterDate",
             ):
                 section = Package.find("types", name=mdtype)
                 if section is not None:

{cumulusci-3.61.0.dev1 → cumulusci-3.61.0.dev3}/cumulusci/schema/cumulusci.jsonschema.json

@@ -388,6 +388,10 @@
                     "default": "mdapi",
                     "enum": ["sfdx", "mdapi"],
                     "type": "string"
+                },
+                "custom": {
+                    "title": "Custom",
+                    "type": "object"
                 }
             },
             "additionalProperties": false

{cumulusci-3.61.0.dev1 → cumulusci-3.61.0.dev3}/cumulusci/tasks/create_package_version.py

@@ -137,16 +137,27 @@ class CreatePackageVersion(BaseSalesforceApiTask):
     def _init_options(self, kwargs):
         super()._init_options(kwargs)
 
+        # Allow these fields to be explicitly set to blanks
+        # so that unlocked builds can override an otherwise-configured
+        # postinstall script
+        if "post_install_script" in self.options:
+            post_install_script = self.options["post_install_script"]
+        else:
+            post_install_script = self.project_config.project__package__install_class
+
+        if "uninstall_script" in self.options:
+            uninstall_script = self.options["uninstall_script"]
+        else:
+            uninstall_script = self.project_config.project__package__uninstall_class
+
         self.package_config = PackageConfig(
             package_name=self.options.get("package_name")
             or self.project_config.project__package__name,
             package_type=self.options.get("package_type")
             or self.project_config.project__package__type,
             org_dependent=self.options.get("org_dependent", False),
-            post_install_script=self.options.get("post_install_script")
-            or self.project_config.project__package__install_class,
-            uninstall_script=self.options.get("uninstall_script")
-            or self.project_config.project__package__uninstall_class,
+            post_install_script=post_install_script,
+            uninstall_script=uninstall_script,
             namespace=self.options.get("namespace")
             or self.project_config.project__package__namespace,
             version_name=self.options.get("version_name") or "Release",

cumulusci-3.61.0.dev3/cumulusci/tasks/robotframework/template.html

@@ -0,0 +1,109 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8" />
+        <script
+            src="https://code.jquery.com/jquery-3.3.1.slim.min.js"
+            integrity="sha256-3edrmyuQ0w65f8gfBsqowzjJe2iM6n0nKciPUp8y+7E="
+            crossorigin="anonymous"
+        ></script>
+        <script>
+            function filter() {
+                var filter_string = $("#filter").val().toLowerCase();
+                $(".kwtable .kwname").each(function () {
+                    if ($(this).text().toLowerCase().indexOf(filter_string) !== -1) {
+                        $(this).parent().show();
+                    } else {
+                        $(this).parent().hide();
+                    }
+                });
+            }
+            $(document).ready(function () {
+                $("#filter").on("input", function () {
+                    filter();
+                });
+                $("#filter").keyup(function () {
+                    filter();
+                });
+            });
+        </script>
+        <style>
+            {{stylesheet}}
+        </style>
+    </head>
+    <body>
+        <div class="container">
+            <!-- this is the header for the documentation as a whole -->
+            <div class="header">
+                <h1 class="title">{{title}}</h1>
+                <div class="filter right">
+                    filter: <input id="filter" type="filter" />
+                </div>
+            </div>
+
+            {% for kwfile in libraries %}
+            <div class="file" id="file-{{kwfile.path}}">
+                <div class="file-header">
+                    <h2 title="{{kwfile.path}}">{{kwfile.title}}</h2>
+                    <div class="file-path">{{kwfile.path}}</div>
+                </div>
+
+                {% if kwfile.doc %}
+                <div class="pageobject-file-description">{{kwfile.doc|robot_html}}</div>
+                {% endif %} {% for pageobject, library in kwfile.keywords.items() %}
+                <div class="section" pageobject="{{pageobject|join('-')}}">
+                    {% if pageobject %}
+                    <div class="pageobject-header">
+                        <table class="pageobject-header">
+                            <tbody>
+                                <tr class="data">
+                                    <td title="Page Type">{{pageobject[0]}}</td>
+                                    {% if pageobject[1] %}
+                                    <td title="Object Name">{{pageobject[1]}}</td>
+                                    {% endif %}
+                                </tr>
+                                <tr class="labels">
+                                    <td>Page Type</td>
+                                    {% if pageobject[1] %}
+                                    <td>Object Name</td>
+                                    {% endif %}
+                                </tr>
+                            </tbody>
+                        </table>
+                    </div>
+                    {% endif %}
+
+                    <div class="description" title="Description">
+                        {{library.doc|robot_html}}
+                    </div>
+                    <table class="kwtable" title="Table of keywords">
+                        <tbody>
+                            <tr>
+                                <th>Keyword</th>
+                                <th>Arguments</th>
+                                <th>Documentation</th>
+                            </tr>
+                            {% for keyword in library.keywords %}
+                            <tr
+                                class="kwrow"
+                                id="{{kwfile.filename}}.{{keyword.name.replace(' ', '-')}}"
+                            >
+                                <td class="kwname">{{keyword.name}}</td>
+                                <td class="kwargs">
+                                    {% for arg in keyword.args %}
+                                    <i>{{arg}}</i>{% if not loop.last %}, {% endif %} {%
+                                    endfor %}
+                                </td>
+                                <td class="kwdoc">{{keyword.doc|robot_html}}</td>
+                            </tr>
+                            {% endfor %}
+                        </tbody>
+                    </table>
+                </div>
+                {# class="library-whatever" #} {% endfor %}
+            </div>
+            {% endfor %}
+        </div>
+        <div class="footer">Generated on {{date}} - cumulusci v{{cci_version}}</div>
+    </body>
+</html>

{cumulusci-3.61.0.dev1 → cumulusci-3.61.0.dev3}/cumulusci/tasks/robotframework/tests/test_robotframework.py

@@ -672,7 +672,7 @@ class TestRobotLibDocOutput:
     def test_formatted_documentation(self):
         """Verify that markup in the documentation is rendered as html"""
         doc_element = self.html_body.find(
-            ".//tr[@id='TestLibrary.py.Library Keyword One']//td[@class='kwdoc']"
+            ".//tr[@id='TestLibrary.py.Library-Keyword-One']//td[@class='kwdoc']"
         )
         doc_html = str(ET.tostring(doc_element, method="html").strip())
         # we could just do an assert on the full markup of the
@@ -756,13 +756,13 @@ class TestLibdocPageObjects:
         description = section.find("div[@class='description']")
         expected = '<div class="description" title="Description"><p>Description of SomethingDetailPage</p></div>'
         actual = ET.tostring(description).decode("utf-8").strip()
-        assert actual == expected
+        assert shrinkws(actual) == shrinkws(expected)
 
         section = self.html_body.find(".//div[@pageobject='Listing-Something__c']")
         description = section.find("div[@class='description']")
         expected = '<div class="description" title="Description"><p>Description of SomethingListingPage</p></div>'
         actual = ET.tostring(description).decode("utf-8").strip()
-        assert actual == expected
+        assert shrinkws(actual) == shrinkws(expected)
 
 
 class TestRobotPerformanceKeywords:
@@ -858,3 +858,7 @@ class TestRobotPerformanceKeywords:
             assert list(filter(None, elapsed_times)) == [
                 {"Elapsed Time": 11655.9, "Donuts": 42.3}
             ]
+
+
+def shrinkws(s):
+    return re.sub(r"\s+", " ", s).replace("> <", "><")

{cumulusci-3.61.0.dev1 → cumulusci-3.61.0.dev3}/cumulusci/tasks/salesforce/org_settings.py

@@ -25,6 +25,7 @@ class DeployOrgSettings(Deploy):
     task_options = {
         "definition_file": {"description": "sfdx scratch org definition file"},
         "settings": {"description": "A dict of settings to apply"},
+        "object_settings": {"description": "A dict of objectSettings to apply"},
         "api_version": {"description": "API version used to deploy the settings"},
     }
 
@@ -38,21 +39,24 @@ class DeployOrgSettings(Deploy):
 
     def _run_task(self):
         settings = {}
+        object_settings = {}
         if self.options.get("definition_file"):
             with open(self.options["definition_file"], "r") as f:
                 scratch_org_definition = json.load(f)
                 settings = scratch_org_definition.get("settings", {})
+                object_settings = scratch_org_definition.get("objectSettings", {})
 
         dictmerge(settings, self.options.get("settings", {}))
+        dictmerge(object_settings, self.options.get("object_settings", {}))
 
-        if not settings:
+        if not settings and not object_settings:
             self.logger.info("No settings provided to deploy.")
             return
 
         api_version = (
             self.options.get("api_version") or self.org_config.latest_api_version
         )
-        with build_settings_package(settings, None, api_version) as path:
+        with build_settings_package(settings, object_settings, api_version) as path:
             self.options["path"] = path
             return super()._run_task()
 

{cumulusci-3.61.0.dev1 → cumulusci-3.61.0.dev3}/cumulusci/tasks/salesforce/tests/test_ProfileGrantAllAccess.py

@@ -269,6 +269,66 @@ def test_throws_exception_record_type_not_found():
         task._transform_entity(metadata_tree.fromstring(ADMIN_PROFILE_BEFORE), "Admin")
 
 
+def test_transforms_profile_with_layouts():
+    task = create_task(
+        ProfileGrantAllAccess,
+        {
+            "record_types": [
+                {
+                    "record_type": "Account.HH_Account",
+                    "page_layout": "Account-Account Layout",
+                },
+                {
+                    "record_type": "Account.Business_Account",
+                    "page_layout": "Account-Account Layout",
+                    "default": True,
+                },
+            ],
+        },
+    )
+
+    # To support coverage for when pulling metadata with layout definitions
+    profile_before = ADMIN_PROFILE_BEFORE.replace(
+        b"</Profile>",
+        b"""\n      <layoutAssignments>
+            <recordType>Account.Business_Account</recordType>
+            <layout>Account-Business Account Layout</layout>
+        </layoutAssignments>
+    </Profile>""",
+    )
+
+    inbound = metadata_tree.fromstring(profile_before)
+    assert len(inbound.findall("layoutAssignments")) == 1
+
+    # Verify the expected input includes the layoutAssignment element and
+    # the original layout
+    assert (
+        inbound.find("layoutAssignments", recordType="Account.Business_Account")
+        .find("layout")
+        .text
+        == "Account-Business Account Layout"
+    )
+
+    # Run the transformation and assert that there are two layoutAssignments
+    outbound = task._transform_entity(inbound, "Admin")
+    assert len(outbound.findall("layoutAssignments")) == 2
+
+    # Verify that the original layout assignment was updated
+    assignments = outbound.find(
+        "layoutAssignments", recordType="Account.Business_Account"
+    )
+    assert assignments is not None
+    assert assignments.find("layout").text == "Account-Account Layout"
+
+    assignments = outbound.find("layoutAssignments", recordType="Account.HH_Account")
+    assert assignments is not None
+    assert assignments.find("layout").text == "Account-Account Layout"
+
+    # assert that the nodes are included in the xml output as expected
+    xml_output = outbound.tostring(xml_declaration=True)
+    assert xml_output.count("<layoutAssignments>") == 2
+
+
 def test_expand_package_xml():
     task = create_task(ProfileGrantAllAccess, {"api_names": ["Admin"]})
     task.tooling = mock.Mock()
@@ -287,6 +347,30 @@ def test_expand_package_xml():
     assert "fb__Foo_Bar__c" in {elem.text for elem in types.findall("members")}
 
 
+def test_expand_package_xml_objects():
+    task = create_task(
+        ProfileGrantAllAccess,
+        {"api_names": ["Admin"], "record_types": [{"record_type": "Case.Case"}]},
+    )
+    task.tooling = mock.Mock()
+    package_xml = metadata_tree.fromstring(PACKAGE_XML_BEFORE)
+    task._expand_package_xml_objects(package_xml)
+    types = package_xml.find("types", name="CustomObject")
+    assert "Case" in {elem.text for elem in types.findall("members")}
+
+
+def test_expand_package_xml_objects_no_record_types():
+    task = create_task(
+        ProfileGrantAllAccess,
+        {"api_names": ["Admin"]},
+    )
+    task.tooling = mock.Mock()
+    package_xml = metadata_tree.fromstring(PACKAGE_XML_BEFORE)
+    task._expand_package_xml_objects(package_xml)
+    types = package_xml.find("types", name="CustomObject")
+    assert "Case" not in {elem.text for elem in types.findall("members")}
+
+
 def test_expand_package_xml__broken_package():
     task = create_task(ProfileGrantAllAccess, {"api_names": ["Admin"]})
     task.tooling = mock.Mock()

{cumulusci-3.61.0.dev1 → cumulusci-3.61.0.dev3}/cumulusci/tasks/salesforce/tests/test_org_settings.py

@@ -76,6 +76,50 @@ class TestDeployOrgSettings:
 </OtherSettings>"""
         )
 
+    def test_run_task__json_only__with_org_settings(self):
+        with temporary_dir() as d:
+            with open("dev.json", "w") as f:
+                json.dump(
+                    {
+                        "settings": {
+                            "orgPreferenceSettings": {"s1DesktopEnabled": True},
+                            "otherSettings": {
+                                "nested": {
+                                    "boolValue": True,
+                                    "stringValue": "string",
+                                },
+                            },
+                        },
+                        "objectSettings": {"foo__c": {"sharingModel": "Private"}},
+                    },
+                    f,
+                )
+            path = os.path.join(d, "dev.json")
+            task_options = {"definition_file": path, "api_version": "48.0"}
+            task = create_task(DeployOrgSettings, task_options)
+            task.api_class = Mock()
+            task()
+
+        package_zip = task.api_class.call_args[0][1]
+        zf = zipfile.ZipFile(io.BytesIO(base64.b64decode(package_zip)), "r")
+        # The context manager's output is tested separately, below.
+        assert (
+            readtext(zf, "package.xml")
+            == """<?xml version="1.0" encoding="UTF-8"?>
+<Package xmlns="http://soap.sforce.com/2006/04/metadata">
+    <types>
+        <members>Foo__c</members>
+        <name>CustomObject</name>
+    </types>
+    <types>
+        <members>OrgPreference</members>
+        <members>Other</members>
+        <name>Settings</name>
+    </types>
+    <version>48.0</version>
+</Package>"""
+        )
+
     def test_run_task__settings_only(self):
         settings = {
             "orgPreferenceSettings": {"s1DesktopEnabled": True},

{cumulusci-3.61.0.dev1 → cumulusci-3.61.0.dev3}/cumulusci/tasks/salesforce/update_profile.py

@@ -28,7 +28,10 @@ class ProfileGrantAllAccess(MetadataSingleEntityTransformTask, BaseSalesforceApi
             "the record type in format <object>.<developer_name>.  Record type names can use the token strings {managed} "
             "and {namespaced_org} for namespace prefix injection as needed.  By default, all listed record types will be set "
             "to visible and not default.  Use the additional keys `visible`, `default`, and `person_account_default` set to "
-            "true/false to override.  NOTE: Setting record_types is only supported in cumulusci.yml, command line override is not supported."
+            "true/false to override.  "
+            "Page Layout Support: If you are using the Page Layouts feature, you can specify the `page_layout` key with the "
+            "layout name to use for the record type.  If not specified, the default page layout will be used.  "
+            "NOTE: Setting record_types is only supported in cumulusci.yml, command line override is not supported."
         },
         "managed": {
             "description": "If True, uses the namespace prefix where appropriate.  Use if running against an org with the managed package "
@@ -178,6 +181,27 @@ class ProfileGrantAllAccess(MetadataSingleEntityTransformTask, BaseSalesforceApi
                 text=f"{record['NamespacePrefix']}__{record['DeveloperName']}__c",
             )
 
+        self._expand_package_xml_objects(package_xml)
+
+    def _expand_package_xml_objects(self, package_xml):
+        # Check for any record types specified in the options, but missing from the package.xml
+        # Add these entities to the package.xml
+
+        custom_objects = package_xml.find("types", name="CustomObject")
+
+        # Append custom objects if record types are present but missing from package.xml
+        record_types = self.options.get("record_types") or []
+        rt_objects = {rt["record_type"].split(".")[0] for rt in record_types}
+        listed_custom_objects = {c.text for c in custom_objects.findall("members")}
+
+        for rt in rt_objects:
+            if rt not in listed_custom_objects:
+                self.logger.info('Adding "{}" to package.xml'.format(rt))
+                custom_objects.append(
+                    "members",
+                    text=rt,
+                )
+
     def _transform_entity(self, tree, api_name):
         # Custom applications
         self._set_elements_visible(tree, "applicationVisibilities", "visible")
@@ -254,5 +278,26 @@ class ProfileGrantAllAccess(MetadataSingleEntityTransformTask, BaseSalesforceApi
             if pa_default is not None:
                 pa_default.text = str(rt.get("person_account_default", "false")).lower()
 
+        # Set page layout defaults for record types
+        for rt in record_types:
+            # We need it to look like this:
+            # <layoutAssignments>
+            #   <layout>{page_layout}</layout>
+            #   <recordType>{record_type}</recordType>
+            # </layoutAssignments>
+            layout_option = rt.get("page_layout", None)
+            if layout_option:
+                # Look for page layout definitions in the record type
+                found_layout = False
+                for elem in tree.findall("layoutAssignments"):
+                    if elem.find("recordType").text == rt["record_type"]:
+                        elem.layout.text = layout_option
+                        found_layout = True
+
+                if not found_layout:
+                    assignment = tree.append(tag="layoutAssignments")
+                    assignment.append(tag="recordType", text=rt["record_type"])
+                    assignment.append(tag="layout", text=layout_option)
+
 
 UpdateAdminProfile = UpdateProfile = ProfileGrantAllAccess

{cumulusci-3.61.0.dev1 → cumulusci-3.61.0.dev3}/cumulusci/tasks/tests/test_create_package_version.py

@@ -95,29 +95,34 @@ def project_config(repo_root):
 
 
 @pytest.fixture
-def task(project_config, devhub_config, org_config):
-    task = CreatePackageVersion(
-        project_config,
-        TaskConfig(
-            {
-                "options": {
-                    "package_type": "Managed",
-                    "org_dependent": False,
-                    "package_name": "Test Package",
-                    "static_resource_path": "static-resources",
-                    "ancestor_id": "04t000000000000",
-                    "create_unlocked_dependency_packages": True,
-                }
-            }
-        ),
-        org_config,
-    )
-    with mock.patch(
-        "cumulusci.tasks.create_package_version.get_devhub_config",
-        return_value=devhub_config,
-    ):
-        task._init_task()
-    return task
+def get_task(project_config, devhub_config, org_config):
+    def _get_task(options=None):
+        opts = options or {
+            "package_type": "Managed",
+            "org_dependent": False,
+            "package_name": "Test Package",
+            "static_resource_path": "static-resources",
+            "ancestor_id": "04t000000000000",
+            "create_unlocked_dependency_packages": True,
+        }
+        task = CreatePackageVersion(
+            project_config,
+            TaskConfig({"options": opts}),
+            org_config,
+        )
+        with mock.patch(
+            "cumulusci.tasks.create_package_version.get_devhub_config",
+            return_value=devhub_config,
+        ):
+            task._init_task()
+        return task
+
+    return _get_task
+
+
+@pytest.fixture
+def task(get_task):
+    return get_task()
 
 
 @pytest.fixture
@@ -168,6 +173,25 @@ class TestCreatePackageVersion:
     devhub_base_url = "https://devhub.my.salesforce.com/services/data/v52.0"
     scratch_base_url = "https://scratch.my.salesforce.com/services/data/v52.0"
 
+    def test_postinstall_script_logic(self, get_task):
+        task = get_task({"package_type": "Managed", "package_name": "Foo"})
+
+        # Values set in the fixture project_config above
+        assert task.package_config.post_install_script == "Install"
+        assert task.package_config.uninstall_script == "Uninstall"
+
+        task = get_task(
+            {
+                "package_type": "Unlocked",
+                "package_name": "Foo",
+                "post_install_script": None,
+                "uninstall_script": None,
+            }
+        )
+
+        assert task.package_config.post_install_script is None
+        assert task.package_config.uninstall_script is None
+
     @responses.activate
     def test_run_task(
         self,

{cumulusci-3.61.0.dev1 → cumulusci-3.61.0.dev3}/cumulusci/tests/test_utils.py

@@ -224,7 +224,9 @@ class TestUtils:
         task_doc = utils.doc_task("scoop_icecream", task_config)
         assert (
             task_doc
-            == """**scoop_icecream**
+            == """.. _scoop-icecream:
+
+scoop_icecream
 ==========================================\n
 **Description:** Scoops icecream\n
 **Class:** cumulusci.tests.test_utils.FunTestTask\n
@@ -299,6 +301,7 @@ Options\n------------------------------------------\n\n
         flow_doc = utils.document_flow("test flow", "test description.", coordinator)
 
         expected_doc = (
+            ".. _test flow:\n\n"
             "test flow"
             "\n^^^^^^^^^\n"
             "\n**Description:** test description.\n"
@@ -306,7 +309,7 @@ Options\n------------------------------------------\n\n
             "\n.. code-block:: console\n"
         )
 
-        assert expected_doc == flow_doc
+        assert expected_doc == flow_doc, flow_doc
 
     def test_document_flow__additional_info(self):
         flow_steps = ["1) (Task) Extract"]
@@ -321,6 +324,7 @@ Options\n------------------------------------------\n\n
         )
 
         expected_doc = (
+            ".. _test flow:\n\n"
             "test flow"
             "\n^^^^^^^^^\n"
             "\n**Description:** test description.\n"
@@ -329,6 +333,9 @@ Options\n------------------------------------------\n\n
             "\n.. code-block:: console\n"
             "\n\t1) (Task) Extract"
         )
+        if expected_doc != flow_doc:
+            print(repr(expected_doc))
+            print(repr(flow_doc))
         assert expected_doc == flow_doc
 
     @responses.activate

{cumulusci-3.61.0.dev1 → cumulusci-3.61.0.dev3}/cumulusci/utils/__init__.py

@@ -341,7 +341,8 @@ def doc_task(task_name, task_config, project_config=None, org_config=None):
     from cumulusci.core.utils import import_global
 
     doc = []
-    doc.append(f"**{task_name}**\n==========================================\n")
+    doc.append(f".. _{task_name.replace('_', '-')}:\n")
+    doc.append(f"{task_name}\n==========================================\n")
     doc.append(f"**Description:** {task_config.description}\n")
     doc.append(f"**Class:** {task_config.class_path}\n")
 
@@ -458,6 +459,7 @@ def document_flow(flow_name, description, flow_coordinator, additional_info=None
     """Document (project specific) flow configurations in RST format"""
     doc = []
 
+    doc.append(f".. _{flow_name.replace('_', '-')}:\n")
     doc.append(f"{flow_name}\n{'^' * len(flow_name)}\n")
     doc.append(f"**Description:** {description}\n")