Cumulusci

Issues Closed:

- Fixed a regression that prevented running unmanaged flows on persistent orgs, due to the use of the ``include_beta`` option while installing dependencies, which is not allowed for persistent orgs. We changed the ``update_dependencies`` task to ignore the option and log a warning when running against a persistent org, instead of erroring.

Critical Changes:

- The flows `dev_org`, `dev_org_namespaced`, `qa_org`, `ci_feature`,
and `install_beta` now run the `update_dependencies` task with the
`include_beta` option enabled, so dependencies will be installed
using the most recent beta release instead of the most recent final
release. The `beta_dependencies` flow is no longer used and is
considered deprecated.
- The flows `ci_feature_beta_deps` and `dev_org_beta_deps` are now
deprecated and should be replaced by their default equivalents
above.
- The `ci_feature_2gp` flow has been changed to use `config_apextest`
instead of `config_managed` to avoid configuration steps that are
unnecessary for running Apex tests. This means that in order for
`ci_feature_2gp` to work, `config_apextest` must be set up to work
in both managed and unmanaged contexts.
- When connecting GitHub using `cci service connect github`, we now
prompt for a personal access token instead of a password. (GitHub
has removed support for accessing the API using a password as of
November 2020.) If you already had a token stored in the `password`
field, it will be transparently migrated to `token`. If you were
specifying `--password` on the command line when running this
command, you need to switch to `--token` instead.
- Removed the old `cumulusci.tasks.command.SalesforceBrowserTest` task
class which has not been used for some time.

Changes:

- Added a standard `qa_org_2gp` flow, which can be used to set up a QA
org using a 2nd-generation package version that was previously
created using the `build_feature_test_package` flow. This flow makes
use of the `config_qa` flow, which means that `config_qa` must be
set up to work in both managed and unmanaged contexts. This flow is
considered experimental and may change at any time.
- The `batch_apex_wait` task can now wait for Queueable Apex jobs in
addition to batch Apex.
- The `custom_settings_value_wait` task now waits if the expected
Custom Settings record does not yet exist, and does case insensitive
comparison of field names.

- Preflight checks:
- Added a task, `check_sobject_permissions`, to validate sObject
permissions.
- Added a task, `check_advanced_currency_management`, to determine
whether or not Advanced Currency Management is active.

- Robot Framework:
- In the Robot Framework Salesforce resource, the
`Open Test Browser` keyword now accepts an optional `useralias`
argument which can be used to open a browser as a different
user. The user must already have been created or authenticated
using the Salesforce CLI.
- Updated to [Snowfakery 1.3][].

Issues Closed:

- Improved error handling of REST API responses to confirm they are
JSON.
- Fixed error handling in the `load_dataset` task in Windows.
- Fixed a bug where pressing `Ctrl+C` while running `cci org connect`
in Windows did not exit. (\2027)
- Fixed a bug where deploying an LWC component bundle using the
`deploy` task did not include files in subfolders.
- Fixed the `deploy` task so that deploying an empty metadata
directory does not error.
- Fixed a bug where the `namespace_inject` option was not included
when freezing deploy steps for MetaDeploy, causing namespace
injection to not work when running the plan in MetaDeploy.
- Fixed a bug where running the `robot` task as a cross-project task
could not load Robot Framework libraries from the other project.

Changes:

- CumulusCI now accepts a normalized task option syntax in the form
of: `--opt-name value`. This can be used in place of the old task
option syntax: `-o opt-name value`.
- Tasks which perform namespace injection can now automatically
determine whether they are running in the context of a managed
installation or a namespaced scratch org. This means that in many
cases it is no longer necessary to explicitly specify options like
`managed`/`unmanaged`/`namespaced`/`namespaced_org`/`namespace_inject`,
or to use a separate flow for namespaced scratch orgs.
- The `deploy_unmanaged` flow now deploys sfdx-formatted metadata
using the Metadata API rather than the sfdx `force:source:push`
command. This avoids an issue where sfdx could show an error about
the pushed components conflicting with other changes that already
happened in the org. It also improves consistency between how
metadata is deployed to a scratch org and how it is deployed to a
packaging org.
- Removed the `namespaced_org` option for the `update_dependencies`
task, which was not functional.
- We added support for including SOQL where-clauses `Salesforce Query`
Robot keyword via the `where` keyword argument.
- The `create_package_version` task can accept a
`static_resource_path` option.
- The FindReplace task now has a `replace_env` option which, if true,
will interpret the `replace` option as the name of an environment
variable whose value should be used for the replacement.
- We added a new command, `cci project doc`, which will document
project-specific tasks to a reStructuredText file.

Issues closed:

- An error that occurred when building a second-generation package
using a cross-project task has been fixed.
- The `github_package_data` task will now work for projects using API
versions prior to 44.0.
- Fixed a bug where namespace injection of the `%%%NAMESPACED_ORG%%%`
token with the `namespaced_org` option enabled did not actually add
the namespace prefix unless the `managed` option was also enabled.
- We fixed an issue that resulted in the
<span class="title-ref">batch\_size</span> option in a data mapping
file being ignored.

Changes:

- We added support for using Robot keywords from other projects that are included as `sources`.
- The `suites` option of the robot task can now take a list of suite paths. Paths can include a prefix representing a remote repository as defined by the `sources` configuration option (eg: `-o suites npsp:robot/Cumulus/tests/api`)
- The robot task has a new `sources` option to work in conjunction with the global `sources` option to allow the use of keywords and tests from other repositories.
- When running the `robot` task, the folder containing downloaded repositories via the `sources` option are added to `PYTHONPATH` so that robot tests can find library and resource files in those repositories
- Bulk Data tasks now support adding or removing a namespace from a mapping file to match the target org.
- We improved how we parse Boolean values in Bulk Data tasks and in command line options. True can be represented as "yes", "y", "true", "on", or "1", with any capitalization, and False as "no", "n", "false", "off", "0". None as a synonym for False is deprecated.
- We added support for including managed package release details in automatically generated release notes.
- We added a task, `assign_permission_sets`, to assign Permission Sets to a user.
- We updated the default API version for new projects to 50.0.
- The `build_feature_test_package` flow now creates a 2GP package version with the "skip validation" option turned on.
- `github_automerge_main` now only merges to the lowest numbered release branch when multiple are detected.

Issues closed:

- We fixed an issue with relative imports within parallel Robot test runs by adding the repo root to PYTHONPATH.
- We fixed an issue with generating `package.xml` manifests for directories that contain reports in folders that aren't owned by the project.
- We now handle an exception that may occur while creating merge conflict PRs during parent-child automerges.

Issues closed:

- Added a workaround for a slow query error while looking up installed packages in Winter ‘21 orgs.

Changes:

- The ``update_admin_profile`` task now accepts the ``api_names`` option to target extra Profiles, even when using a custom ``package.xml``.
- The ``github_automerge_main`` task can now be used on source branches other than the default branch to merge them into branches starting with the ``branch_prefix`` option, as long as the source branch does not also start with ``branch_prefix``.
- Added preflight check tasks to validate org settings (``check_org_settings_value``) and to check that Chatter is enabled (``check_chatter_enabled``). These are intended for use with MetaDeploy install plans.
- Updated to [Snowfakery 1.2](https://github.com/SFDO-Tooling/Snowfakery/releases/tag/v1.2).

Issues closed:

- Fixed an issue in the ``load_dataset`` task which left out non-Person-Account Contacts if the dataset was extracted using the REST API.