alexskrypnyk / drupal_extension_scaffold Goto Github PK

Once init script is implemented in #110, we can split the file in 2 (similar to how it is done in https://github.com/AlexSkrypnyk/scaffold)

This is an advanced case to allow any dependencies, including VCS repositories, to be merged with main site dependencies to be installed for testing.

Possibly, use merge plugin
https://github.com/wikimedia/composer-merge-plugin

1. Updated the rector.php config as per https://github.com/drevops/scaffold/blob/develop/rector.php#L53
2. Update current example module code to contain declare(strict_types=1);.
3. Check if Coder rules in phpcs.xml pick up the missing declare(strict_types=1);. If so - find a package that enforces this rule and add it as a dev dependency to composer.json.

Add GitHub Actions support. Once this is implemented, this project would allow the user to choose which CI provider they would want to use.

1. Use only scripts from .devtools, but feel free to modify them, if required.
2. Use the same PHP versions matrix as for CircleCI
3. Use the same Drupal versions matrix as for CircleCI
4. Use the format and naming convention of a workflow and jobs from https://github.com/AlexSkrypnyk/scaffold/blob/main/.github/workflows/test-php.yml

See an existing CI implementation: https://github.com/drupal-composer/drupal-project/blob/10.x/.github/workflows/ci.yml

vendor/bin/phpcs || [ "${CI_PHPCS_IGNORE_FAILURE:-0}" -eq 1 ]

etc.

Currently, this repo is named after CirceCI. When GitHub actions are added in #64, this repo would need to be renamed to something neutral, keeping in mind that this repo is for contrib development and not for full-blown consumer site development (https://drevops.com is that).

Variants are:

• drupal_module_scaffold

We need to simplify the setup process as per https://github.com/AlexSkrypnyk/drupal_extension_scaffold?tab=readme-ov-file#setup

• Look at the init script from another scaffold and implement the same approach (copy/paste)
  https://github.com/AlexSkrypnyk/scaffold/blob/main/init.sh
• Add bats tests into .scaffold/tests/bats dir (same as in https://github.com/AlexSkrypnyk/scaffold) repo
• Make sure that the script removes .scaffold dir after run.

The questions themselves should be adjusted for this repo:

1. namespace
2. name
3. machine_name
4. type: module or theme
5. ci_provider - GitHub Actions or CircleCI

Add ahoy update command (a wrapper for update.sh script) to ease the update process

This is about providing the documentation for this scaffold repo, not the repo being scaffolded.

1. Get docs app setup as in https://github.com/AlexSkrypnyk/scaffold into .scaffold/docs dir. Update paths as required.
2. Add empty sections as Markdown files:

• Introduction (use README.md as this is a first page)
• Setup
• Usage
• FAQs

4. Add GHA integration to publish to GH pages using the default GH domain.

Note: proper domain will be added in a separate ticket.

Refer to implementation in https://github.com/integratedexperts/drupal-dev

1. Retire PHP 8.1 jobs in CI
2. Add PHP 8.3 jobs in CI

something like

echo "  > Adding custom patches."
cat <<< "$(jq --indent 4 '.extra.patches = {"drupal/core": {"Builds failing on missing layout column plugin": "https://www.drupal.org/files/issues/2023-07-16/3204271-20-missing-layout-exception.patch"}}' "${BUILD_DIR}/composer.json")" > "${BUILD_DIR}/composer.json"

create local shorthand functions like below and update the rest of the script

drush() { "${BUILD_DIR}/vendor/bin/drush" -y "$@"; }

If module provides FE deps - add support to install them.

if [ -f "build/web/modules/custom/${module}/package-lock.json" ]; then
  pushd "build/web/modules/custom/${module}/" > /dev/null || exit 1
  echo "  > Installing theme assets."
  [ -f ".nvm" ] && nvm use || true
  [ ! -d "node_modules" ] && npm ci || true
  popd > /dev/null || exit 1
fi

Add support for behat testing if the root of the project has behat.yml file.

Once #110 implemented, we want to have tests that execute the same activities as a developer would do locally.

We also want to make sure that lint and test failures are picked up by scripts, meaning that we want to have a test where we introduce a failure, running a tool (phpcs, phpstan etc.) and asserting that they have indeed failed.

See https://github.com/AlexSkrypnyk/scaffold/tree/main/tests/scaffold for an example on how to setup tests. (Note that the location in that repo for Scaffold's tests is not correct - the tests should be in .scaffold/tests dir, not tests/scaffold - there is a ticket to fix that in that repo).

Please note that you would need to install ahoy into container - see https://github.com/ahoy-cli/ahoy

Add additional jobs to install Drupal into a subdirectory and run tests.

Implement support for Drupal 9

==> Install additional dev dependencies from module's composer.json
./.circleci/build.sh: line 36: jq: command not found

Installed jq, problem solved.

D8 won't have PHP8 support as per https://www.drupal.org/project/drupal/issues/3156651

• module installs configuration when enabled
• behat test check configuration

It should be easy to add config for GitPod

Assess the current code coverage in Codecove reports and provide more unit and functional tests to increase the coverage.

Implement only after #126

Try removing 'repositories' from composer.json and add it to build.sh.

This is useful for enabling XDebug (the PHP server has to be restarted)

Symlinking allows to modify configs and have these modifications propagated.

Renovate tries to update PHP versions but we want the versions to stay as-is.

#91

Similar to https://github.com/AlexSkrypnyk/scaffold/blob/main/.github/workflows/scaffold-test.yml#L17

Sorry, but I can't understand what to do in the step 2 in CircleCI, I need to create a new key?, if that was the case, what I need to put in hostname?.

In the step 3, where I can obtain the fingerprint?, in github?, sorry but I'm very confused, please give me a clue.

The repo can be used to create themes and modules, so need to update all code references to be agnostic to the type of the extension.

https://www.drupal.org/docs/develop/git/using-gitlab-to-contribute-to-drupal/gitlab-ci#s-using-your-own-gitlab-ciyml-file

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

The built artefact created in build directory has PHPCS and PHPStan added as a part of the build.

But there are no config files added for these tools AND there is no way to point the tools to use those configs (unless the tool can somehow discover the config automatically).

We need to do 4 things here:

1. Update .circleci/build.sh part echo " > Installing other dev dependencies." to use:

php -d memory_limit=-1 "$(command -v composer)" --working-dir="${BUILD_DIR}" require --dev \
  dealerdirect/phpcodesniffer-composer-installer \
  phpspec/prophecy-phpunit:^2 \
  mglaman/phpstan-drupal:^1.2 \
  palantirnet/drupal-rector:^0.18 \
  friendsoftwig/twigcs:^6.2 

2. Copy configs from https://github.com/drevops/drevops/tree/main for PHPC, PHPStan, Rector and TWIGCS and update them accordingly.
3. Assess if we need to update .circleci/lint.sh with paths to configurations (based on the tool).
4. Update README.md file with a newly added list of tools (TWIGCS).

https://www.drupal.org/project/drupal/issues/2974911

• Connect to Codecov
• Switch to native PHPUnit + use config from drevops/scaffold
• Add example code (maybe into src) to test to demonstrate that coverage works
• Add pcov to CIs and use it instead of XDebug
• Update init.sh to remove the example code.
• Add coverage label to README.dist.md
• Review and remove .devtools/test.sh

Download the latest code from Scaffold repo (actual code, not the release).

• Update composer.json with the structure from Scaffold. Preserve the values of the existing fields, but order the fields as per Scaffold's composer.json. Add missing fields. Do not add scripts. This is an example file to use for the Drupal module itself. It is not meant to be used as a composer install. So just make sure that the order is correct.
• Add Renovate config from Scaffold
• Add/update all GitHub actions and configs to be per Scaffold. Note that the test GHA workflow should NOT be used.
• Update readme to use the structure from Scaffold, including the generated logo (circle). Do not change the contents of the sections, just the structure.
• Do not add PHPStan or PHPCS packages - these are added automatically when the site is built. We will need to add the config files, but this will be handled in the separate issue (#79).
• Reformat composer.json to have indents and sorting as per the Scaffold.

Make sure that CI passes.

Similar task for reference: AlexSkrypnyk/shellvar#17

https://github.com/AlexSkrypnyk/scaffold/blob/main/.github/release-drafter.yml

This requires applying patch from https://www.drupal.org/files/issues/2189345-39_0.patch

• Add support for make to be a command parity to ahoy.yml.
• Add tests. May need to install make into container.

Only implement this after #126 is done