diff --git a/README.md b/README.md index 2261ab7..8352bcb 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,12 @@ This repository is a recipe for DDEV to have a local worker that will allow taki Add this addon as `ddev get diffywebsite/ddev-diffy`. -Register an account in Diffy and create an API key. While installation of the addon you will be asked for API KEY and PROJECT ID. Please provide them so configuration is saved. +Register an account in Diffy and create an [API key](https://stage.diffy.website/#/keys). + +Once you have your container ready after `ddev restart` we need to provide API key and project ID to `.env` file. For that go to `.ddev/diffy-worker`, copy existing example file `cp .env.example .env` and edit `.env` file to provide your credentials. To run the screenshots do `ddev screenshot`. It will produce a URL to your screenshots uploaded to Diffy. Next you can compare them to your any other sets (production, staging, baseline etc.). +Remember to check our [documentation page](https://docs.diffy.website/features/local-development/ddev-add-on). + **Contributed and maintained by [@ygerasimov](https://github.com/ygerasimov)** diff --git a/install.yaml b/install.yaml index 963374b..bebc3f9 100644 --- a/install.yaml +++ b/install.yaml @@ -2,46 +2,6 @@ name: ddev-diffy -pre_install_actions: - # Get DIFFY_API_KEY from user if we don't have it yet - - | - #ddev-nodisplay - if ( {{ contains "DIFFY_API_KEY" (list .DdevGlobalConfig.web_environment | toString) }} || {{ contains "DIFFY_API_KEY" (list .DdevProjectConfig.web_environment | toString) }} ); then - echo "Using existing DIFFY_API_KEY." - else - printf "\n\nPlease enter your Diffy API key: " - fi - - - | - #ddev-nodisplay - #ddev-description:Setting DIFFY_API_KEY - if !( {{ contains "DIFFY_API_KEY" (list .DdevGlobalConfig.web_environment | toString) }} || {{ contains "DIFFY_API_KEY" (list .DdevProjectConfig.web_environment | toString) }} ); then - read token - # Put the token into the global web environment - ddev config global --web-environment-add DIFFY_API_KEY=${token} - echo "DIFFY_API_KEY set globally" - fi - - - | - #ddev-nodisplay - # echo 'list ddevprojectconfig.web_environment={{ list .DdevProjectConfig.web_environment | toString }}' - if ({{ contains "DIFFY_PROJECT_ID=" (list .DdevProjectConfig.web_environment | toString) }} ); then - echo "Using existing DIFFY_PROJECT_ID from project config.yaml." - else - printf "\n\nPlease enter your Diffy project ID (like '123123'): " - fi - - - | - #ddev-nodisplay - #ddev-description:Set DIFFY_PROJECT_ID - if !( {{ contains "DIFFY_PROJECT_ID" (list .DdevProjectConfig.web_environment | toString) }} ); then - read diffy_project_id - echo "diffy_project_id = '${diffy_project_id}'" - # Put the diffy_project_id in to the project's diffy environment - ddev config --web-environment-add DIFFY_PROJECT_ID=${diffy_project_id} - echo "DIFFY_PROJECT_ID set to ${diffy_project_id}" - fi - project_files: - docker-compose.diffy.yaml - commands/diffy/screenshot @@ -55,39 +15,6 @@ global_files: post_install_actions: - rm -rf diffy-worker && mkdir diffy-worker - docker run -it --rm -v ./diffy-worker:/diffy-worker --user $DDEV_UID:$DDEV_GID ddev/ddev-utilities bash -c "cd /diffy-worker && wget -qO- https://github.com/DiffyWebsite/diffy-worker/archive/refs/heads/main.tar.gz | tar xz --strip-components=1" - - | - #ddev-nodisplay - #ddev-description:Create .env file - DIFFY_API_KEY='{{- $foundDiffApiKey := false -}} - {{- range .DdevGlobalConfig.web_environment }} - {{- if not $foundDiffApiKey }} - {{- $keyVal := splitList "=" . }} - {{- if eq (index $keyVal 0) "DIFFY_API_KEY" }} - {{- index $keyVal 1 -}} - {{- $foundDiffApiKey = true -}} - {{- end }} - {{- end }} - {{- end }}' - - DIFFY_PROJECT_ID='{{- $foundDiffProjectId := false -}} - {{- range .DdevProjectConfig.web_environment }} - {{- if not $foundDiffProjectId }} - {{- $keyVal := splitList "=" . }} - {{- if eq (index $keyVal 0) "DIFFY_PROJECT_ID" }} - {{- index $keyVal 1 -}} - {{- $foundDiffProjectId = true -}} - {{- end }} - {{- end }} - {{- end }}' - - cat <<-EOF >diffy-worker/.env - # #ddev-generated - NODE_ENV=dev - DEBUG=true - DIFFY_PROJECT_ID=${DIFFY_PROJECT_ID} - DIFFY_API_KEY=${DIFFY_API_KEY} - - EOF # Shell actions that can be done during removal of the add-on removal_actions: