Cumulusci

Critical changes:

- We are planning to remove functionality in CumulusCI's dependency management in a future release.

- The `update_dependencies` task will no longer support uninstalling managed packages in a persistent org as part of the dependency installation process.
- The `allow_newer` option on `update_dependencies` will be removed and always be True.
- The `project__dependencies` section in `cumulusci.yml` will no longer support nested dependencies specified like this ::

dependencies:
- namespace: "test"
version: "1.0"
dependencies:
- namespace: "parent"
version: "2.2"


All dependencies should be listed in install order.

We recommend reformatting nested dependencies and discontinuing use of ``allow_newer`` and package uninstalls now to prepare for these future changes.

Changes:

- We released a [new suite of documentation for CumulusCI](https://cumulusci.readthedocs.io/en/latest/).
- CumulusCI now caches org describe data in a local database to provide significant performance gains, especially in `generate_dataset_mapping`.
- The `cci org browser` command now has a `--path` option to open a specific page and a `--url-only` option to output the login URL without spawning a browser.
- We improved messaging about errors while loading `cumulusci.yml`.
- CumulusCI now uses Snowfakery 1.6 (see its [release notes](https://github.com/SFDO-Tooling/Snowfakery/releases/tag/v1.6)).

Changes:

- The message shown at the end of running a flow now includes the org name. 2390, thanks Julian88Tex

- Added new preflight check tasks:

- ``get_existing_record_types`` checks for existing Record Types. 2371, thanks ClayTomerlin
- ``get_assigned_permission_sets`` checks the current user's Permission Set Assignments. 2386

- The ``generate_package_xml`` task now supports the Muting Permission Set metadata type. 2382

- The ``uninstall_packaged_incremental`` and ``uninstall_packaged`` tasks now support a ``dry_run`` option, which outputs the destructiveChanges package manifest to the log instead of executing it. 2393

- Robot Framework:

- The ``Run Task`` keyword now uses the correct project config when running a task from a different source project. 2391
- The SalesforceLibrary has a new keyword, ``Scroll Element Into View``, which is more reliable on Firefox than the keyword of the same name in SeleniumLibrary. 2391

Issues closed:

- Fixed very slow ``cci org connect`` on Safari. 2373

- Added a workaround for decode errors that sometimes happen while processing cci logs on Windows. 2392

- If there's an error while doing JWT authentication to an org, we now log the full response from the server. 2384

- Robot Framework: Improved stability of the ``ObjectManagerPageObject``. 2391

Changes:

- Added a new task, ``composite_request``, for calling the Composite REST Resource. 2341

- The ``create_package_version`` task has a new option, ``version_base``, which can be used to increment the package version from a different base version instead of from the highest existing version of the 2gp package. The ``build_feature_test_package`` flow now uses this option to create a package version with the minor version incremented from the most recent 1gp release published to github. 2357

- The ``create_package_version`` task now supports setting a post-install script and uninstall script when creating a managed package version, by setting the ``post_install_script`` and ``uninstall_script`` options. By default, these options will use the values of ``install_class`` and ``uninstall_class`` from the ``package`` section of ``cumulusci.yml``. 2366

- Updated to [Snowfakery 1.5](https://github.com/SFDO-Tooling/Snowfakery/releases/tag/v1.5>).

- Robot Framework:

- The ``Click related list button`` keyword has been modified to be more liberal in the types of DOM elements it will click on. Prior to this change it only clicked on anchor elements, but now also works for related list buttons that use an actual button element. 2356

- The ``Click modal button`` keyword now attempts to find the given button anywhere on the modal rather than only inside a ``force-form-footer`` element. 2356

Issues closed:

- Robot Framework:

- Custom locators can now be used with keywords that expect no element to be found (such as ``Page should not contain``). This previously resulted in an error. 2346

- Fixed an error when setting the ``tagstatexclude`` option for the ``robot`` task. 2365

- Fixed a possible error when running CumulusCI flows embedded in a multi-threaded context. 2347

Changes:

- Snowfakery 1.4 which includes min, max, round functions. PR 2335

- The ``ensure_record_types`` task has a new option, ``force_create``, which will create the Record Type even if other Record Types already exist on the object. (Thanks to bethbrains) PR 2323

- Allow num_records and num_records_tablename to be omitted when using the task generate_and_load_from_yaml. PR 2322

- Added a new Metadata ETL task, add_fields_to_field_set which allows adding fields to existing field sets. (Thanks to bethbrains) PR 2334

- org_settings now accepts a dict option called settings in addition to (or instead of) the existing definition_file option. (Thanks to bethbrains) PR 2337

- New Robot Keywords for Performance Testing: 2291

* Set Test Elapsed Time: This keyword captures a computed rather than measured elapsed time for performance tests.

* Start Perf Time, End Perf Time: start a timer and then store the result.

* Set Test Metric: store any test metric, not just elapsed time.

- CumulusCI now reports how long it took for flows to run. 2249

Issues Closed:

- Fixed an error that could occur while cleaning cache directories.

- Fixed potential bugs in the Push Upgrade tasks.

- CumulusCI displays more user friendly error message when encountering parsing errors in cumulusci.yml. 2311

- We fixed an issue causing the extract_dataset task to fail in some circumstances when both an anchor date and Record Types were used. 2300

- Handle a possible gack while collecting info about installed packages 2299

Changes:

- CumulusCI now reports how long it took for flows to run.
- Flows `ci_feature` and `ci_feature_beta_deps` now only run the
`github_automerge_feature` task if the branch begins with the
configured feature branch prefix.
- Running the `deploy` task with the `path` option set to a path that
doesn't exist will log a warning instead of raising an error.
- When the `ci_feature_2gp` and `qa_org_2gp` flows install
dependencies, the latest beta version will be used when available.
- CumulusCI can now resolve dependencies using second-generation
packages (2GPs) for upstream projects. When a 2GP build runs on a
release branch (starting with `prefix/NNN`, where `prefix` is the
feature branch prefix and `NNN` is an integer), CumulusCI will look
for a matching release branch in each upstream dependency and use a
2GP package build on that release branch if present, falling back to
a 1GP beta release if not present.

Issues Closed:

- Fixed the `org_settings` task to handle nested structures in org
settings.
- Fixed a bug where cci task run could fail without a helpful error if
run outside of a cci project folder.
- Fixed an issue that caused CumulusCI to generate invalid
`package.xml` entries for Metadata API-format projects that include
`__mocks__` or `__tests__` LWC directories.
- Fixed the `update_dependencies` task to handle automatic injection
of namespace prefixes when deploying an unpackaged dependency. The
fix for the same issue in CumulusCI 3.25.0 was incomplete.
- Fixed an issue where an unquoted `anchor_date` in bulk data mapping
failed validation.
- CumulusCI now handles an error that can occur while collecting info
about installed packages
- Fixed an issue causing the `extract_dataset` task to fail in some
circumstances when both an anchor date and Record Types were used.
- Fixed an issue where the deprecated syntax for record types was not
working in the `load_dataset` task.

Changes:

- New tasks:
- `assign_permission_set_groups` assigns Permission Set Groups to
a user if not already assigned.
- `assign_permission_set_licenses` assigns Permission Set Licenses
to a user if not already assigned.
- New preflight checks for use with MetaDeploy install plans:
- `check_enhanced_notes_enabled` checks if Enhanced Notes are
enabled.
- `check_my_domain_active` checks if My Domain is active.
- The `github_copy_subtree` task has a new option, `renames`, which
allows mapping between local and target path names when publishing
to support renaming a file or directory from the source repository
in the target repository.
- The `ensure_record_types` task has a new option,
`record_type_description`, which can be used to set the description
of the new record type if it is created.
- Robot Framework:
- New keyword `Field value should be`
- New keyword `Modal should show edit error for fields` to check
form field error notifications in Spring '21
- Adjusted `Get field value` and `Select dropdown value` fields to
work in Spring '21
- Command line improvements:
- The various `cci org` commands now accept an org name with the
`--org` option, for better consistency with other commands.
Specifying an org name without `--org` also still works.
- Running `cci org default` without specifying an org name will
now display the current default org.
- Org configs now have properties
`org_config.is_multiple_currencies_enabled` and
`org_config.is_advanced_currency_management_enabled` which can be
used to check if these features are enabled.
- The `MergeBranchOld` task, which was previously deprecated, has now
been removed.

Issues closed:

- Fixed the `update_dependencies` task to handle automatic injection
of namespace prefixes when deploying an unpackaged dependency.
- Fixed the `query` task, which was completely broken.
- Fixed the `connected_app` task to pass the correct username to sfdx.
Thanks atrancadoris
- Fixed the display of task options with an underscore in
`cci task info` output.
- Fixed a confusing warning when creating record types using
Snowfakery. (\2093)
- Improved handling of errors while deleting a scratch org.