Skip to content

Commit

Permalink
Update README for older versions of DDEV (#7)
Browse files Browse the repository at this point in the history
* Update README for older versions of DDEV

Update installation command and add note for older versions in `README.md`.

* Update the installation command to use `ddev add-on get` instead of `ddev get`.
* Add a note for older versions to use `ddev get` instead of `ddev add-on get`.

Update `tests/test.bats` to use `ddev add-on get` command.

* Update the `ddev get` command to `ddev add-on get` in the `install from directory` test.
* Update the `ddev get` command to `ddev add-on get` in the `install from release` test.

* fix: update note formatting in README

---------

Co-authored-by: Thomas Hauschild <[email protected]>
  • Loading branch information
dermatz and Morgy93 authored Nov 1, 2024
1 parent e56b0f8 commit e18a2fa
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,13 @@ YouTube Shorts: [Gum: Write Glamorous Shell Scripts](https://www.youtube.com/wat
## Installation

```shell
ddev get Morgy93/ddev-gum
ddev add-on get Morgy93/ddev-gum
ddev restart
```

> [!NOTE]
> For DDEV versions prior to v1.23.5, use `ddev get` instead of `ddev add-on get`.
## Usage

### Host shell
Expand Down
9 changes: 4 additions & 5 deletions tests/test.bats
Original file line number Diff line number Diff line change
Expand Up @@ -26,18 +26,17 @@ teardown() {
@test "install from directory" {
set -eu -o pipefail
cd ${TESTDIR}
echo "# ddev get ${DIR} with project ${PROJNAME} in ${TESTDIR} ($(pwd))" >&3
ddev get ${DIR}
echo "# ddev add-on get ${DIR} with project ${PROJNAME} in ${TESTDIR} ($(pwd))" >&3
ddev add-on get ${DIR}
ddev restart
health_checks
}

@test "install from release" {
set -eu -o pipefail
cd ${TESTDIR} || ( printf "unable to cd to ${TESTDIR}\n" && exit 1 )
echo "# ddev get ${DDEV_ADDON} with project ${PROJNAME} in ${TESTDIR} ($(pwd))" >&3
ddev get ${DDEV_ADDON}
echo "# ddev add-on get ${DDEV_ADDON} with project ${PROJNAME} in ${TESTDIR} ($(pwd))" >&3
ddev add-on get ${DDEV_ADDON}
ddev restart >/dev/null
health_checks
}

0 comments on commit e18a2fa

Please sign in to comment.