Skip to content

Commit

Permalink
DQA-9155: Prepare toolkit release 10.10.0
Browse files Browse the repository at this point in the history
  • Loading branch information
joaocsilva committed Apr 12, 2024
1 parent 060b3fd commit 9e3c7f2
Show file tree
Hide file tree
Showing 4 changed files with 90 additions and 62 deletions.
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
# Toolkit change log

## Version 10.10.0
- DQA-8677: Improve check-version.
- DQA-8687: Exclude non-drupal packages from is_installed check.
- DQA-8678: Improve toolkit:requirements.
- DQA-8767: Allow component-check command to execute specific tasks.
- DQA-8663: Component check improvements.
- DQA-8639: Assets/CSS are not compiled in distribution.
- DQA-8675: Restore toolkit notifications feature .
- DQA-8681: Transport sanitisation check from audit into toolkit.
- DQA-8682: Enforce sanitization code into projects.
- DQA-9119: Toolkit opts-review to check DUMP_OPTIONS.
- DQA-8963: Update robo documentation links.

## Version 10.9.0
- DQA-8674: Include ASDA_URL in the list of forbidden variables.
- DQA-8699: Update toolkit information in composer and repository.
Expand Down
135 changes: 75 additions & 60 deletions docs/guide/commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,69 +14,84 @@ See bellow current list of available commands:
.. code-block::
Available commands:
completion Dump the shell completion script
config Dumps the current or given configuration.
help Display help for a command
list List commands
completion Dump the shell completion script
config Dumps the current or given configuration.
help Display help for a command
list List commands
check
check:abandoned Check abandoned components.
check:composer Check composer packages.
check:configuration Check project configuration.
check:development Check development components.
check:evaluation Check Evaluation components.
check:insecure Check insecure components.
check:mandatory Check mandatory components.
check:outdated Check outdated components.
check:recommended Check recommended components.
check:unsupported Check unsupported components.
docker
docker:refresh-configuration [dk-rc] Update docker-compose.yml file based on project's configurations.
docker:refresh-configuration [dk-rc] Update docker-compose.yml file based on project's configurations.
drupal
drupal:check-permissions Command to check the forbidden permissions.
drupal:config-import Run the Drupal config import.
drupal:disable-cache Disable aggregation and clear cache.
drupal:drush-setup Write Drush configuration file at "${drupal.root}/drush/drush.yml".
drupal:permissions-setup Setup Drupal permissions.
drupal:settings-setup Setup Drupal settings.php file in compliance with Toolkit conventions.
drupal:site-install [drupal:si|dsi] Install target site.
drupal:site-post-install Run Drupal post-install commands.
drupal:site-pre-install Run Drupal pre-install commands.
drupal:symlink-project Symlink project as module, theme or profile in the proper directory.
drupal:upgrade-status [tdus] Check project compatibility for Drupal 9/10 upgrade.
drupal:check-permissions Command to check the forbidden permissions.
drupal:check-sanitisation-classes Command to check existence of Sanitisation classes.
drupal:check-sanitisation-fields Command to check fields for sanitisation.
drupal:config-import Run the Drupal config import.
drupal:disable-cache Disable aggregation and clear cache.
drupal:drush-setup Write Drush configuration file at "${drupal.root}/drush/drush.yml".
drupal:permissions-setup Setup Drupal permissions.
drupal:settings-setup Setup Drupal settings.php file in compliance with Toolkit conventions.
drupal:site-install [drupal:si|dsi] Install target site.
drupal:site-post-install Run Drupal post-install commands.
drupal:site-pre-install Run Drupal pre-install commands.
drupal:symlink-project Symlink project as module, theme or profile in the proper directory.
drupal:upgrade-status [tdus] Check project compatibility for Drupal 9/10 upgrade.
toolkit
toolkit:build-assets [tk-assets|tba] Build theme assets (Css and Js).
toolkit:build-dev [tk-bdev] Build site for local development.
toolkit:build-dev-reset [tk-bdev-reset] Build site for local development from scratch with a clean git.
toolkit:build-dist [tk-bdist] Build the distribution package.
toolkit:check-phpcs-requirements Make sure that the config file exists and configuration is correct.
toolkit:check-version Check the Toolkit version.
toolkit:code-review Execute all or specific tools for static testing.
toolkit:complock-check Check if 'composer.lock' exists on the project root folder.
toolkit:component-check Check composer for components that are not whitelisted/blacklisted.
toolkit:create-dump [tk-cdump] Export the local snapshot.
toolkit:download-dump [tk-ddump] Download database snapshot.
toolkit:fix-permissions Run script to fix permissions (experimental).
toolkit:hooks-delete-all [tk-hdel] Remove all existing hooks, this will ignore active hooks list.
toolkit:hooks-disable [tk-hdis] Disable the git hooks.
toolkit:hooks-enable [tk-hen] Enable the git hooks defined in the configuration or in given option.
toolkit:hooks-list [tk-hlist] List available hooks and its status.
toolkit:hooks-run [tk-hrun] Run a specific hook.
toolkit:import-config [DEPRECATED] Run the Drupal config import.
toolkit:install-clean [tk-iclean] Install a clean website.
toolkit:install-clone [tk-iclone] Install a clone website.
toolkit:install-dependencies Install packages present in the opts.yml file under extra_pkgs section.
toolkit:install-dump [tk-idump] Import the production snapshot.
toolkit:lint-js [tk-js|tljs] Run lint JS.
toolkit:lint-php [tk-php|tlp] Run lint PHP.
toolkit:lint-yaml [tk-yaml|tly] Run lint YAML.
toolkit:opts-review [tk-opts-review] Check project's .opts.yml file for forbidden commands.
toolkit:patch-download [tk-pd] Download remote patches into a local directory.
toolkit:patch-list [tk-pl] Lists remote patches from the root composer.json.
toolkit:requirements [tk-req] Check the Toolkit Requirements.
toolkit:run-blackfire [tk-bfire|tbf] Run Blackfire.
toolkit:run-deploy [tk-deploy] Run deployment sequence.
toolkit:run-gitleaks [tk-gitleaks] Executes the Gitleaks.
toolkit:run-phpcbf [tk-phpcbf] Run PHP code autofixing.
toolkit:setup-behat Setup the Behat file.
toolkit:setup-blackfire-behat Copy the needed resources to run Behat with Blackfire.
toolkit:setup-eslint Setup the ESLint configurations and dependencies.
toolkit:setup-phpcs Setup PHP code sniffer.
toolkit:setup-phpunit Setup the PHPUnit file.
toolkit:test-behat [tk-behat|tb] Run Behat tests.
toolkit:test-phpcs [tk-phpcs] Run PHP code sniffer.
toolkit:test-phpmd [tk-phpmd] Run PHPMD.
toolkit:test-phpstan [tk-phpstan] Run PHPStan.
toolkit:test-phpunit [tk-phpunit|tp] Run PHPUnit tests.
toolkit:vendor-list Check 'Vendor' packages being monitored.
toolkit:build-assets [tk-assets|tba] Build theme assets (Css and Js).
toolkit:build-assets-dist Run the toolkit:build-assets for distribution
toolkit:build-dev [tk-bdev] Build site for local development.
toolkit:build-dev-reset [tk-bdev-reset] Build site for local development from scratch with a clean git.
toolkit:build-dist [tk-bdist] Build the distribution package.
toolkit:check-phpcs-requirements Make sure that the config file exists and configuration is correct.
toolkit:check-version Check the Toolkit version.
toolkit:code-review Execute all or specific tools for static testing.
toolkit:complock-check Check if 'composer.lock' exists on the project root folder.
toolkit:component-check Check composer for components that are not whitelisted/blacklisted.
toolkit:create-dump [tk-cdump] Export the local snapshot.
toolkit:download-dump [tk-ddump] Download database snapshot.
toolkit:fix-permissions Run script to fix permissions (experimental).
toolkit:hooks-delete-all [tk-hdel] Remove all existing hooks, this will ignore active hooks list.
toolkit:hooks-disable [tk-hdis] Disable the git hooks.
toolkit:hooks-enable [tk-hen] Enable the git hooks defined in the configuration or in given option.
toolkit:hooks-list [tk-hlist] List available hooks and its status.
toolkit:hooks-run [tk-hrun] Run a specific hook.
toolkit:import-config [DEPRECATED] Run the Drupal config import.
toolkit:install-clean [tk-iclean] Install a clean website.
toolkit:install-clone [tk-iclone] Install a clone website.
toolkit:install-dependencies Install packages present in the opts.yml file under extra_pkgs section.
toolkit:install-dump [tk-idump] Import the production snapshot.
toolkit:lint-js [tk-js|tljs] Run lint JS.
toolkit:lint-php [tk-php|tlp] Run lint PHP.
toolkit:lint-yaml [tk-yaml|tly] Run lint YAML.
toolkit:notifications [tk-notifications] Display Toolkit notifications.
toolkit:opts-review [tk-opts-review] Check project's .opts.yml file for forbidden commands.
toolkit:patch-download [tk-pd] Download remote patches into a local directory.
toolkit:patch-list [tk-pl] Lists remote patches from the root composer.json.
toolkit:requirements [tk-req] Check the Toolkit Requirements.
toolkit:run-blackfire [tk-bfire|tbf] Run Blackfire.
toolkit:run-deploy [tk-deploy] Run deployment sequence.
toolkit:run-gitleaks [tk-gitleaks] Executes the Gitleaks.
toolkit:run-phpcbf [tk-phpcbf] Run PHP code autofixing.
toolkit:setup-behat Setup the Behat file.
toolkit:setup-blackfire-behat Copy the needed resources to run Behat with Blackfire.
toolkit:setup-eslint Setup the ESLint configurations and dependencies.
toolkit:setup-phpcs Setup PHP code sniffer.
toolkit:setup-phpunit Setup the PHPUnit file.
toolkit:test-behat [tk-behat|tb] Run Behat tests.
toolkit:test-phpcs [tk-phpcs] Run PHP code sniffer.
toolkit:test-phpmd [tk-phpmd] Run PHPMD.
toolkit:test-phpstan [tk-phpstan] Run PHPStan.
toolkit:test-phpunit [tk-phpunit|tp] Run PHPUnit tests.
toolkit:vendor-list Check 'Vendor' packages being monitored.
.. toolkit-block-commands-end
Expand Down
2 changes: 1 addition & 1 deletion phpdoc.dist.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<paths>
<output>docs</output>
</paths>
<version number="10.9.0">
<version number="10.10.0">
<folder>latest</folder>
<api>
<source dsn=".">
Expand Down
2 changes: 1 addition & 1 deletion src/Toolkit.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ final class Toolkit
/**
* Constant holding the current version.
*/
public const VERSION = '10.9.0';
public const VERSION = '10.10.0';

/**
* The Toolkit repository.
Expand Down

0 comments on commit 9e3c7f2

Please sign in to comment.