cumulusci.yml

# * Copyright (c) 2021, salesforce.com, inc.
# * All rights reserved.
# * SPDX-License-Identifier: BSD-3-Clause
# * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
# *
minimum_cumulusci_version: "3.34.1"
project:
    name: OutboundFundsCommunity
    package:
        name: Outbound Funds Community
        namespace: outfunds_comm
        api_version: "52.0"
    dependencies:
        - namespace: sfdobase
          version: 1.0
        - github: "https://github.com/SalesforceFoundation/OutboundFundsModule"
    dependency_resolutions:
        preproduction: include_beta
    git:
        default_branch: "main"
        repo_url: "https://github.com/SalesforceFoundation-emu/OutboundFundsModuleSite"
    source_format: sfdx

orgs:
    scratch:
        prerelease:
            config_file: orgs/prerelease.json
        beta_prerelease:
            config_file: orgs/beta_prerelease.json
tasks:
    # Automerge Major Release Branches
    github_automerge_feature:
        options:
            update_future_releases: True

    # Robot test configuration
    robot:
        options:
            suites: robot/OutboundFundsCommunity/tests
            options:
                outputdir: robot/OutboundFundsCommunity/results

    robot_testdoc:
        options:
            path: robot/OutboundFundsCommunity/tests
            output: robot/OutboundFundsCommunity/doc/OutboundFundsCommunity_tests.html

    run_tests:
        options:
            retry_failures:
                - "unable to obtain exclusive access to this record"
                - "UNABLE_TO_LOCK_ROW"
            retry_always: True
            required_org_code_coverage_percent: "100"

    robot_libdoc:
        options:
            path: robot/OutboundFundsCommunity/resources/OutboundFundsCommunity.py,robot/OutboundFundsCommunity/resources/OutboundFundsCommunity.robot,robot/OutboundFundsCommunity/resources/*PageObject.py
            output: robot/OutboundFundsCommunity/doc/Keywords.html

    uninstall_packaged_incremental:
        options:
            ignore:
                ContentAsset:
                    - Outbound_Funds_Module_Default_Hero
                    - Outbound_Funds_Module_Default_Logo
                    - Outbound_Funds_Module_Body
                    - GCCS_Foundation_hero
                    - GCCS_Foundation_logo

    # Fundseeker customer enablement
    fundseeker_create_site:
        group: "OFM-Site: Fundseeker customer enablement"
        description: Creates a site with the OFM Experience Template.
        class_path: cumulusci.tasks.salesforce.CreateCommunity
        options:
            template: Fundseeker Starter Portal
            name: Fundseeker Portal
            url_path_prefix: fundseekerportal
            timeout: 60000

    fundseeker_publish_site:
        group: "OFM-Site: Fundseeker customer enablement"
        description: Publishes the Fundseeker Portal site so we can later deploy NetworkBranding.
        class_path: cumulusci.tasks.salesforce.PublishCommunity
        options:
            name: Fundseeker Portal

    fundseeker_configure_guest_user_profile:
        group: "OFM-Site: Fundseeker customer enablement"
        description: Deploys our recommended configuration of the Site Guest User Profile, e.g. assigns Layouts.
        class_path: cumulusci.tasks.salesforce.Deploy
        options:
            path: unpackaged/fundseeker_customer_enablement/guest_user_profile

    fundseeker_add_network_members:
        group: "OFM-Site: Fundseeker customer enablement"
        description: Create a NetworkMemberGroup records.
        class_path: cumulusci.tasks.salesforce.network_member_group.CreateNetworkMemberGroups
        options:
            network_name: Fundseeker Portal
            profile_names:
                - Fundseeker Plus Login

    fundseeker_deploy_network_branding:
        group: "SFDO-Grants: Customer enablement"
        description: Deploys the NetworkBranding files for the Fundseeker Portal. Must be deployed after creating the "Fundseeker Portal" Community.
        class_path: cumulusci.tasks.salesforce.Deploy
        options:
            path: unpackaged/fundseeker_customer_enablement/network_branding

    fundseeker_deploy_sharing_set:
        group: "OFM-Site: Fundseeker customer enablement"
        description: Deploys our recommended Sharing Set for the Fundseeker Plus Login Profile.
        class_path: cumulusci.tasks.salesforce.Deploy
        options:
            path: unpackaged/fundseeker_customer_enablement/sharing_set

    fundseeker_check_sharing_set_owds:
        class_path: cumulusci.tasks.preflight.sobjects.CheckSObjectOWDs
        group: "Preflight Checks"
        options:
            org_wide_defaults:
                - api_name: outfunds__Funding_Request__c
                  external_sharing_model: Private
                - api_name: outfunds__Requirement__c
                  external_sharing_model: Private

    fundseeker_check_enable_networks_enabled:
        description: Preflight check to validate that Digital Experiences are enabled.
        group: "Preflight Checks"
        class_path: cumulusci.tasks.preflight.settings.CheckSettingsValue
        options:
            settings_type: CommunitiesSettings
            settings_field: IsNetworksEnabledEnabled
            value: true

    # All stories
    common_secure_owds_by_default:
        group: "OFM-Site: stories"
        description: Sets organization-wide default (OWD) sharing configuration as private both internally and externally.
        class_path: cumulusci.tasks.metadata_etl.SetOrgWideDefaults
        options:
            org_wide_defaults:
                - api_name: Account
                  internal_sharing_model: Private
                  external_sharing_model: Private
                # Opportunity + Case must have a sharing model ≤ Account's sharing model.
                - api_name: Opportunity
                  internal_sharing_model: Private
                  external_sharing_model: Private
                - api_name: Case
                  internal_sharing_model: Private
                  external_sharing_model: Private
                - api_name: User
                  internal_sharing_model: Read
                  external_sharing_model: Read
                - api_name: outfunds__Funding_Program__c
                  internal_sharing_model: Private
                  external_sharing_model: Private
                - api_name: outfunds__Funding_Request__c
                  internal_sharing_model: Private
                  external_sharing_model: Private
                - api_name: outfunds__Requirement__c
                  internal_sharing_model: Private
                  external_sharing_model: Private

    common_update_default_scratch_org_user:
        group: "OFM-Site: stories/common"
        description: Updates the default scratch org user to be Aileen Davis, and assigns her a role so her accounts can have community users.
        class_path: cumulusci.tasks.apex.anon.AnonymousApexTask
        options:
            path: stories/common/scripts/update_scratch_org_user.apex

    common_create_site_users:
        group: "OFM-Site: stories/common"
        description: Creates site users for the Fundseeker Portal.
        class_path: cumulusci.tasks.apex.anon.AnonymousApexTask
        options:
            path: stories/common/scripts/create_site_users.apex
            # param1 is a comma-delimited list of Contact.Email to create site users.

    common_reorder_app_menu:
        group: "OFM-Site: stories/common"
        description: Re-orders the app menu for the common story.
        class_path: cumulusci.tasks.apex.anon.AnonymousApexTask
        options:
            path: stories/common/scripts/reorder_app_menu.apex
            # param1 is a comma-delimited list of Application Names.

    common_upload_photo_for_admin_aileen_davis:
        group: "OFM-Site: stories/common"
        description: Uploads a profile photo for admin Aileen Davis.
        class_path: cumulusci.tasks.salesforce.users.photos.UploadProfilePhoto
        options:
            photo: stories/common/images/photos/AileenDavis.png

    common_upload_photo_for_fundseeker_grace_walker:
        group: "OFM-Site: stories/common"
        description: Uploads a profile photo for fundseeker Grace Walker.
        class_path: cumulusci.tasks.salesforce.users.photos.UploadProfilePhoto
        options:
            photo: stories/common/images/photos/GraceWalker.png
            where: Contact.Email = 'grace.walker@steps.example.com'

    common_share_funding_programs_with_accounts_with_funding_requests:
        group: "OFM-Site: stories/common"
        description: If an account has a Funding Request, that site users for that account should be able to view the Funding Program record.
        class_path: cumulusci.tasks.apex.anon.AnonymousApexTask
        options:
            path: stories/common/scripts/share_funding_programs_with_requests.apex

    # dev story
    dev_deploy_unpackaged:
        group: "OFM-Site: stories/dev"
        description: Deploys the bundle of unpackaged for the dev story.
        class_path: cumulusci.tasks.salesforce.DeployBundles
        options:
            path: stories/dev/unpackaged

    dev_load_storytelling_data:
        group: "OFM-Site: stories/dev"
        description: Load storytelling data for the dev story.   Note, this dataset depends on the unpackaged metadata in the dev story.
        class_path: cumulusci.tasks.bulkdata.LoadData
        options:
            mapping: stories/dev/dataset/mapping.yml
            sql_path: stories/dev/dataset/data.sql

    dev_extract_storytelling_data:
        group: "OFM-Site: stories/dev"
        description: Extract storytelling data for the dev story.
        class_path: cumulusci.tasks.bulkdata.ExtractData
        options:
            mapping: stories/dev/dataset/mapping.yml
            sql_path: stories/dev/dataset/data.sql

    # qa story
    qa_common_create_site_users:
        group: "OFM-Site: stories/common"
        description: Creates site users for the Fundseeker Portal.
        class_path: cumulusci.tasks.apex.anon.AnonymousApexTask
        options:
            path: stories/qa/scripts/qa_create_site_users.apex
            # param1 is a comma-delimited list of Contact.Email to create site users.

    qa_deploy_unpackaged:
        group: "OFM-Site: stories/qa"
        description: Deploys the bundle of unpackaged for the qa story.
        class_path: cumulusci.tasks.salesforce.DeployBundles
        options:
            path: stories/qa/unpackaged

    qa_load_storytelling_data:
        group: "OFM-Site: stories/qa"
        description: Load storytelling data for the qa story.   Note, this dataset depends on the unpackaged metadata in the qa story.
        class_path: cumulusci.tasks.bulkdata.LoadData
        options:
            mapping: stories/qa/dataset/mapping.yml
            sql_path: stories/qa/dataset/data.sql

    qa_extract_storytelling_data:
        group: "OFM-Site: stories/qa"
        description: Extract storytelling data for the qa story.
        class_path: cumulusci.tasks.bulkdata.ExtractData
        options:
            mapping: stories/qa/dataset/mapping.yml
            sql_path: stories/qa/dataset/data.sql

    # Internal development automation
    dev_export_ofm_community_template:
        group: "OFM: Internal dev automation"
        description: 'Exports specified temporary Community Template metadata. Change the options to export changes you are interested in. Remember, the temporary Community Template API Name must start with "template_name" option, and the "suffix" is everything after the "template_name" option in temporary Community Template API Name.'
        class_path: dev.tasks.community_templates.ExportCommunityTemplateTask
        options:
            template_name: OFM_Portal
            suffix: "2"
            export_template: True
            export_theme: True
            export_branding_set: True
            export_flexipages: True
            copy_temporary_metadata: False

    common_replace_theme_layout_navigation_menu:
        group: "SFDO-Grants: Internal config and storytelling"
        description: Replaces the Navigation Menu in the community for all pages using the Grants Community theme
        class_path: dev.tasks.communities.ReplaceThemeLayoutNavigationMenuTask
        options:
            network_name: Fundseeker Portal
            navigation_menu: OFM_Portal_Navigation1

    add_apply_quick_action_to_funding_program_layout:
        group: "OFM-Site: Fundseeker customer enablement"
        description: Adds the Apply quick action to the Funding Program Experience Site layout.
        class_path: cumulusci.tasks.metadata_etl.layouts.AddRecordPlatformActionListItem
        options:
            api_names: "outfunds__Funding_Program__c-%%%NAMESPACE%%%OFM Funding Program Site Layout"
            action_name: "outfunds__Funding_Program__c.Apply"
            action_type: QuickAction
            place_first: true

    add_submit_quick_action_to_requirement_layout:
        group: "OFM-Site: Fundseeker customer enablement"
        description: Adds the Submit quick action to the Requirement Experience Site layout.
        class_path: cumulusci.tasks.metadata_etl.layouts.AddRecordPlatformActionListItem
        options:
            api_names: "outfunds__Requirement__c-%%%NAMESPACE%%%OFM Requirement Site Layout"
            action_name: "outfunds__Requirement__c.Submit"
            action_type: QuickAction
            place_first: true

    add_submit_application_quick_action_to_funding_request_layout:
        group: "OFM-Site: Fundseeker customer enablement"
        description: Adds the Submit quick action to the Funding Request Experience Site layout.
        class_path: cumulusci.tasks.metadata_etl.layouts.AddRecordPlatformActionListItem
        options:
            api_names: "outfunds__Funding_Request__c-%%%NAMESPACE%%%OFM Funding Request Site Layout"
            action_name: "outfunds__Funding_Request__c.SubmitApplication"
            action_type: QuickAction
            place_first: true

flows:
    # dev story
    dev_story:
        steps:
            1:
                flow: fundseeker_customer_enablement
            2:
                task: common_secure_owds_by_default
            3:
                task: dev_deploy_unpackaged
            4:
                task: common_reorder_app_menu
                options:
                    param1: "Outbound_Funds,outbound funds portal,Community"
            5:
                task: dev_load_storytelling_data
            6:
                task: common_update_default_scratch_org_user
            7:
                task: common_create_site_users
                options:
                    param1: meiko.takagawa@takagawa-institute.example.com,devon.berger@hillside-elementary.example.com,ellen.perez@steps.example.com,grace.walker@steps.example.com
            8:
                task: common_upload_photo_for_admin_aileen_davis
            9:
                task: common_upload_photo_for_fundseeker_grace_walker
            10:
                task: common_share_funding_programs_with_accounts_with_funding_requests
            11:
                flow: common_replace_and_publish_theme_layout_navigation_menu
            12:
                task: add_apply_quick_action_to_funding_program_layout
            13:
                task: add_submit_quick_action_to_requirement_layout
            14:
                task: add_submit_application_quick_action_to_funding_request_layout

    config_dev:
        steps:
            # 1) task: deploy_post [from current folder]
            # 2) task: update_admin_profile
            3:
                flow: dev_story

    dev_org_2gp:
        steps:
            1:
                flow: install_2gp_commit
            2:
                flow: config_dev
            3:
                task: snapshot_changes

    # qa story
    qa_story:
        steps:
            1:
                flow: fundseeker_customer_enablement
            2:
                task: common_secure_owds_by_default
            3:
                task: qa_deploy_unpackaged
            4:
                task: common_reorder_app_menu
                options:
                    param1: "Outbound_Funds,outbound funds portal,Community"
            5:
                task: qa_load_storytelling_data
            6:
                task: common_update_default_scratch_org_user
            7:
                task: qa_common_create_site_users
                options:
                    param1: gms.robotwalker@inbox.testmail.app
            8:
                task: common_upload_photo_for_admin_aileen_davis

            9:
                flow: common_replace_and_publish_theme_layout_navigation_menu
            10:
                task: add_apply_quick_action_to_funding_program_layout
            11:
                task: add_submit_quick_action_to_requirement_layout
            12:
                task: add_submit_application_quick_action_to_funding_request_layout

    config_qa:
        steps:
            # 1) task: deploy_post [from current folder]
            # 2) task: update_admin_profile
            3:
                flow: qa_story

    # beta story
    config_managed:
        steps:
            # 1) task: deploy_post [from current folder]
            # 2) task: update_admin_profile
            3:
                task: common_secure_owds_by_default

    # Customer flows
    fundseeker_customer_enablement:
        description: Customer enablement for the Fundseeker Portal with recommended configuration.
        steps:
            1:
                task: fundseeker_create_site
                ui_options:
                    name: "Create the Fundseeker Portal"
                    is_required: True
            2:
                task: fundseeker_publish_site
                ui_options:
                    name: "Publish the Fundseeker Portal"
                    is_required: True
            3:
                task: fundseeker_add_network_members
                ui_options:
                    name: "Add 'Fundseeker Plus Login' Profile to Fundseeker Portal"
                    is_required: True
            4:
                task: fundseeker_configure_guest_user_profile
                ui_options:
                    name: "Update 'Fundseeker Portal Profile' (Guest User) profile"
                    is_required: True
            5:
                task: fundseeker_deploy_sharing_set
                ui_options:
                    name: "Grant Visibility to Site Users"
                    is_required: True
                checks:
                    - when: "not tasks.fundseeker_check_sharing_set_owds()"
                      action: hide
            6:
                task: add_apply_quick_action_to_funding_program_layout
                ui_options:
                    name: "Add the 'Apply' Quick Action to the 'Funding Program Site Layout' page layout"
                    is_required: True
            7:
                task: add_submit_quick_action_to_requirement_layout
                ui_options:
                    name: "Add the 'Submit' Quick Action to the 'Requirement Site Layout' page layout"
                    is_required: True
            8:
                task: add_submit_application_quick_action_to_funding_request_layout
                ui_options:
                    name: "Add the 'Submit Application' Quick Action to the 'Funding Request Site Layout' page layout"
                    is_required: True

    # Internal flows
    common_replace_and_publish_theme_layout_navigation_menu:
        description: Configures the Fundseeker Portal to use the packaged Navigation Menu instead of the default Navigation Menu.  Then, publishes the Site so the changes are committed in the org.
        steps:
            1:
                task: common_replace_theme_layout_navigation_menu
            2:
                task: fundseeker_publish_site

    customer_org:
        steps:
            1:
                task: deploy_pre
                ui_options:
                    template_content_assets:
                        name: Deploy Visual Assets
            2:
                task: install_managed
            3:
                task: deploy_post
                ui_options:
                    funding_program_application_flow:
                        name: Deploy Create Application Flow And Quick Action
                    fundseeker_plus_login_profile:
                        name: Deploy Fundseeker Plus Login Profile
                    funding_request_submission_flow:
                        name: Deploy Submit Application Flow And Quick Action
                    submit_requirement_flow:
                        name: Deploy Submit Requirement Flow And Quick Action

    customer_org_full:
        steps:
            1:
                flow: customer_org
            2:
                flow: fundseeker_customer_enablement

plans:
    customer_enablement_install:
        slug: install-and-build-portal
        title: Install OFM Fundseeker Starter Portal Template and Build Site
        tier: primary
        is_listed: True
        preflight_message: "This installs the Outbound Funds Module Fundseeker Starter Portal Template into your org and creates the Fundseeker Portal with our recommended configurations."
        post_install_message: "Thanks for installing Outbound Funds Module Fundseeker Starter Portal Template. Visit the [Outbound Funds Module](https://trailhead.salesforce.com/trailblazer-community/groups/0F94S000000kHi0SAE) community group on the Trailblazer Community for any questions about Outbound Funds Module or Outbound Funds Module Fundseeker Starter Portal Template."
        error_message: "To get help with this error, go to [help.salesforce.com](https://help.salesforce.com/), find Support & Services, and log a support ticket with Salesforce. Include “Outbound Funds Module Fundseeker Starter Portal Template” in the subject line and the installation link in the comments."
        checks:
            - when: "not tasks.check_chatter_enabled()"
              action: error
              message: "The Fundseeker Starter Portal Template requires that Chatter is enabled. Enable Chatter in your org and try again."
            - when: "'.my.' not in org_config.instance_url"
              action: error
              message: "The Fundseeker Starter Portal Template requires that My Domain is enabled. Enable My Domain in your org and try again."
            - when: "not tasks.fundseeker_check_enable_networks_enabled()"
              action: error
              message: "The Fundseeker Starter Portal Template requires that Digital Experiences is enabled. Enable Digital Experience in your org and try again."
            - when: "'PID_Customer_Community_Plus_Login' not in tasks.get_available_licenses()"
              action: error
              message: "The Fundseeker Starter Portal Template is an Experience Cloud site template and requires Customer Community Plus Login licenses. Coordinate with your Salesforce account executive to be sure you have the correct licenses in your org."
            - when: "'outfunds' not in tasks.get_installed_packages()"
              action: error
              message: "The Outbound Funds Module Fundseeker Starter Portal Template requires Outbound Funds Module is installed first. Visit https://install.salesforce.org/products/outbound-funds/ to install it and try again."
            - when: "'Fundseeker Portal' in tasks.list_communities()"
              action: error
              message: "An Experience Cloud site with the name 'Fundseeker Portal' already exists."

        steps:
            1:
                flow: customer_org_full

    install:
        slug: install
        title: Install OFM Fundseeker Starter Portal Template
        tier: secondary
        is_listed: True
        preflight_message: "This installs the Outbound Funds Module Fundseeker Starter Portal Experience Cloud template in your org."
        post_install_message: "Thanks for installing Outbound Funds Module Fundseeker Starter Portal Template. Visit the [Outbound Funds Module](https://trailhead.salesforce.com/trailblazer-community/groups/0F94S000000kHi0SAE) community group on the Trailblazer Community for any questions about Outbound Funds Module or Outbound Funds Module Fundseeker Starter Portal Template."
        error_message: "To get help with this error, go to [help.salesforce.com](https://help.salesforce.com/), find Support & Services, and log a support ticket with Salesforce. Include “Outbound Funds Module Fundseeker Starter Portal Template” in the subject line and the installation link in the comments."
        checks:
            - when: "not tasks.check_chatter_enabled()"
              action: error
              message: "Outbound Funds Module Fundseeker Starter Portal Template requires Chatter. Please enable Chatter in your org and try again."
            - when: "'.my.' not in org_config.instance_url"
              action: error
              message: "The Fundseeker Starter Portal Template requires that My Domain is enabled. Enable My Domain in your org and try again."
            - when: "not tasks.fundseeker_check_enable_networks_enabled()"
              action: error
              message: "The Fundseeker Starter Portal Template requires that Digital Experiences is enabled. Enable Digital Experience in your org and try again."
            - when: "'PID_Customer_Community_Plus_Login' not in tasks.get_available_licenses()"
              action: error
              message: "The Fundseeker Starter Portal Template is an Experience Cloud site template and requires Customer Community Plus Login licenses. Coordinate with your Salesforce account executive to be sure you have the correct licenses in your org."
            - when: "'outfunds' not in tasks.get_installed_packages()"
              action: error
              message: "The Outbound Funds Module Fundseeker Starter Portal Template requires Outbound Funds Module is installed first. Visit https://install.salesforce.org/products/outbound-funds/ to install it and try again."

        steps:
            1:
                flow: customer_org

    upgrade:
        slug: upgrade
        title: Product Upgrade
        tier: additional
        is_listed: False
        preflight_message: "This installer upgrades this package and any required dependencies to the latest version in your org. This installer isn't supported and has risks. Please don't run this installer unless you're aware of its specific use cases and considerations."
        post_install_message: "Installation complete and package is on the latest version."
        steps:
            1:
                task: update_dependencies
                options:
                    security_type: PUSH
                    packages_only: True
            2:
                task: install_managed
                options:
                    security_type: PUSH