Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bserem authored Jan 14, 2025
1 parent e53694d commit 5b52749
Showing 1 changed file with 16 additions and 25 deletions.
41 changes: 16 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,20 @@ Highly opinionated set of configs and commands used by Annertech in our DDEV wor

## Install

### 1. Cleanup First

First clean-up previous variations of these files from before they were grouped in an addon.

It is a good idea to update `anrt-tools/docksal-configuration` first:
```
composer update anrt-tools/docksal-configuration
```
This way composer will not overwrite DDEV files that used to live alongside Docksal files (long story).

and then:

```
rm -rf .ddev/settings.ddev.annertech.php
rm -rf .ddev/config.hooks.yaml
rm -rf .ddev/commands/host/branch
rm -rf .ddev/commands/host/login
rm -rf .ddev/commands/web/robo
rm -rf .ddev/commands/web/behat
```

### 2. Get the new addon
### 1. Get the new addon

Then get the addon:
```
ddev get annertech/annertech-ddev
ddev add-on get annertech/annertech-ddev
```

### 3. Commit to project repo
### 2. Commit to project repo

<details>
<summary>
Add add-on files to git (happens automatically)
</summary>

Ideally, add addon files to git:
```
git add .ddev/commands/host/branch -f
git add .ddev/commands/host/cex -f
Expand Down Expand Up @@ -64,6 +47,7 @@ git add .ddev/addon-metadata/ -f
git add .vscode -f
```
</details>

```
git commit -m 'Add annertech/annertech-ddev addon' --no-verify
Expand Down Expand Up @@ -116,10 +100,17 @@ are automatically disabled in local environment to facilitate development.

`ddev behat` command is provided and expects behat to be under `PROJECT_ROOT/tests/behat`.

> **NOTE:**
> Antibot will block Behat! Remember to uninstall it if needed.
### BackstopJS

We rely on https://github.com/mmunz/ddev-backstopjs to get BackstopJS commands in DDEV. Go look there.

### ReCaptcha bypass

See https://github.com/Annertech/annertech-ddev/pull/29/files on how to bypass recaptcha when running automated tests.

## Tricks

Handy shell aliases to add to your **host** machine:
Expand Down

0 comments on commit 5b52749

Please sign in to comment.