Cumulusci

Changes

- Added a `cci plan list` command for displaying a list of
MetaDeploy plans (2940)
- Task options can now be marked as "sensitive". These task options
that will be obfuscated when displayed at the beginning of each task
in a flow. (2939)
- Improved error message when
[](uninstall-packaged-incremental) is run in an
SFDX-format project without converting to Metadata API format first
(2929)
- Improved error messaging for multiple scenarios where tasks are
improperly configured in `cumulusci.yml`. (2923)
- We added a new task [](create-blank-profile) that can be
used to create a new profile from scratch without any permissions
enabled. (This new task requires a Winter 22 Org or API 53.0)
(2908)
- We've added a user-friendly error message when installing a package
using `security_type` "PUSH" with a 04t Package
Version ID. (2935)

Critical Changes

- Backwards incompatibility: the robot task option `debug`
has been renamed to `robot_debug`. (2909)

Changes

- CumulusCI now has a schema published
[here](https://github.com/SFDO-Tooling/CumulusCI/tree/main/cumulusci/schema/cumulusci.jsonschema.json).
This is primarily intended to be use for enabling linting in VS
Code, but could be used for any schema-aware editor or any
validation purpose. (2902)
- We added a new task [](create-blank-profile) that can be
used to create a new profile from scratch without any permissions
enabled. (2908)
- Manually creating a Personal Access Token and pasting it into the
CLI is no longer required to connect a GitHub service. Instead,
CumulusCI now supports GitHub's device authentication flow,
allowing you to authenticate via browser using a temporary device
code. (2911)
- `cci service info` for a github service now displays
expiration dates for GitHub personal access tokens, if set. (2912)
- Improved error messaging for multiple scenarios where tasks are
improperly configured in `cumulusci.yml`. (2923)

Issues Fixed

- Fixed a bug where connecting a GitHub service with `cci service connect` was failing silently. (2888)
- Fixed an issue where MetaDeploy steps using the old
`filename_token` and `namespace_token`
options could not be used. (2914)

Changes

- Updated the `deploy_marketing_cloud_package` task for compatibility
with the October 2021 release of Marketing Cloud. (2899)
- The `--max-lines` option on the `cci error info` command has been
removed. (2895)

Issues fixed

- Removed the unused `--skip` option for the `cci flow run` command.
(2884)
- Flow descriptions no longer generate a warning. (2885)
- We changed how the output from some commands and tasks are displayed
in the CLI. (2887)
- Fixed a bug in freezing the `load_dataset` task options for
MetaDeploy. (2900)
- The marketing cloud `deploy` task now properly exits when a result
status of `FATAL_ERROR` is returned. (2897)
- We fixed a regression in the `push_list` task that affected 2GP push
upgrades (2898)

Issues Fixed

- We fixed a regression that resulted in upload failures for 2GP
packages that extend 1GP packages (closes 2880).

Changes

- CumulusCI uses package version Ids from 1GP releases wherever
available, reducing the need to install 1GP packages in an org to
build 2GP dependencies. (2832)
- We added `metadata_package_id` and `version_id` options to allow
passing `MetadataPackage` (prefix 033) and `MetadataPackageVersion`
(prefix 04t) IDs to the push upgrade tasks. (2837)
- `cci flow info` will now output all flow options defined. (2845)
- We improved error messages for incorrect data mapping files (2831).
- The `snowfakery` task supports specifying the `loading_rules` option
(2861)
- The `snowfakery` task supports recipe options being supplied to
recipes using the `recipe_options` option (2861).

Issues Fixed

- We fixed some errors in the documentation (2854)
- We fixed an issue causing CumulusCI to fail to install releases that
contain an Unlocked Package without a namespace. (2851)
- We added handling for issues that occur when running the
`generate_dataset_mapping` task for very large orgs (2860).
- We fixed a regression in using cross-project sources in MetaDeploy
installers (2875).

Critical Changes

- We now support all package installation options for the
`update_dependencies` and `install_managed` tasks, including
`activate_remote_site_settings`, `security_type`,
`name_conflict_resolution`, and `password` (password not available
for `update_dependencies`). (2811)

We also fixed a minor inconsistency in defaulting the
`activate_remote_site_settings` (or formerly `activateRSS`) option.
Projects that define custom tasks based on the
`InstallPackageVersion` class should ensure they explicitly set the
`activate_remote_site_settings` option, or accept the new default of
True.

MetaDeploy install plans now _do not_ freeze defaulted package
install options. If your install plans are dependent on specific
install options, we recommend explicitly specifying them. Install
plans without explicit options will use the defaults at the time of
execution.

Changes

- The `sources` feature, which allows CumulusCI projects to consume
automation from other projects, now supports specifying a
`resolution_strategy`, just like dependencies. Sources can now
resolve to the same GitHub refs as corresponding dependencies,
including branch matching. The default behavior is to use the
`production` resolution strategy. (2807)
- Added several new tasks for configuring Marketing Cloud:
`marketing_cloud_create_subscriber_attribute`,
`marketing_cloud_create_user`, and
`marketing_cloud_update_user_role`. (2838)
- In the mapping file for the `load_dataset` task, the `batch_size`
can now be specified for Bulk API steps in addition to REST API
steps. (2813)
- The `snowfakery` task now supports the `ignore_row_errors` option to
continue loading even if there are row errors. (2819)
- We made significant updates to the [documentation for Robot
Framework](https://cumulusci.readthedocs.io/en/stable/robot.html).
(2834, 2847)
- We improved option validation for the `add_page_layout_fields` task.
(2828)

Issues Fixed

- Fixed handling of timezones when the `start_time` option is
specified for the push tasks. (2814)
- Fixed the `deploy_marketing_cloud_package` task to handle changes to
the Marketing Cloud API. (2816)
- Fixed an issue where MetaDeploy install steps that used 04t package
version Ids, including 2GP installations, were frozen with incorrect
titles. (2817)
- Fixed an issue causing 2GP commit-status builds to fail when the
local Git repository has a detached HEAD (2818)
- Fixed a bug in the `dry_run` option for the `metadeploy_publish`
task where explicitly setting the option to `False` did not disable
the dry run. (2836)
- Improved the error message shown by the `load_dataset` task if a
table is missing from the dataset. (2813)
- Improved the warning message shown when CumulusCI can't encrypt org
and service config files. (2839)

Internal Changes

- CumulusCI has improved infrastructure for its own integration tests.
(2783)
- Filing a CumulusCI issue on GitHub now presents a form to enter
details. (2829)
- Added a linter to ensure consistent formatting of YAML files within
the CumulusCI codebase. (2844)