Skip to content

Latest commit

 

History

History
150 lines (100 loc) · 4.96 KB

changelog.md

File metadata and controls

150 lines (100 loc) · 4.96 KB
Raw

Change Log

A collection of patch notes and upgrade instructions.

Please add newer logs above older logs. See bottom of file for template.

0.1.1

Author: JCarter

Upgrading:

  • Add DOCKER_CLISCRIPT_PATH to your docker.env.
  • Replace dr.sh, du.sh, and docker-compose.yml.
  • Users may wish to rename their ~/docker dir to ~/docker-data to bring it inline with the new default.

Updates:

  • Readme updated for this update.
  • Defined defaults in dr.sh for DOCKER_YARN_PATH and DOCKER_CLISCRIPT_PATH. There's no perfect solution here as cli path is used in docker-compose, but yarn path is not, etc.
  • A little formatting on the files, nothing that affects functionality.
  • Default shared dir changed to docker-data for clarity.

Features:

  • Added DOCKER_CLISCRIPT_PATH for docker.env which is used by dr.sh to run task.
  • Added task action to dr.sh which lists available dev/tasks or runs a task if one is supplied.
  • Added fpmreload action to dr.sh which runs kill -USR2 1 on the php container.
  • Added DOCKER_SSH_VOLUME for .env which is used by docker-compose.yml to mount ssh dir to phpcli container (needed for mac users). This has no effect for linux users.
  • Added DOCKER_EXEC_IDS for .env which is used by dr.sh to define the executing user (uid:gid) (needed for mac users). This has no effect for linux users.
  • Added fixperms action to dr.sh which sets permissions for all directories and files in DOCKER_SHARED_PATH and the project directory so that containers can rwx to them.
  • Added DOCKER_COMPOSER_TIMEOUT for .env which is used by docker-compose.yml to set the composer timeout. The composer default is 300, and so is the du.sh default.

0.1.0

Author: JCarter

Upgrading:

  • Create docker.env file in project root.
  • Add these vars to docker.env (where relevant). Vars should be wrapped in quotes.
    • Add DOCKER_CONTAINER with same value as CONTAINERS in du.sh.
    • Add DOCKER_PHP_VERSION with php version from docker-compose.yml.
    • Add DOCKER_MYSQL_VERSION with mysql version from docker-compose.yml.
    • Add DOCKER_NODE_VERSION with node version from docker-compose.yml.
    • Add DOCKER_YARN_PATH with same value as YARN_DIR in dr.sh.
  • Commit docker.env to your repo.
  • Replace docker-compose.yml, du.sh, and dr.sh and commit to repo.

Optional:

  • Create .env file in project root and add local docker vars (see below). Do not commit this file.

Fixes:

  • Environment variables are now loaded from .env and docker.env.

Updates:

  • Readme updated with these changes and generally cleaned up.

Renamed:

  • MySQL container renamed from mysql56 to mysql. Existing functionality is unaffected, but keep in mind if running commands directly on containers.
  • PHP_FPM_EXTENSIONS renamed to DOCKER_PHP_COMMAND.

Features:

  • Environment config overhaul.
  • New options for du.sh.

Environment config overhaul:

Project vars (defined in a remote docker.env file).

  • DOCKER_CONTAINERS
  • DOCKER_PHP_VERSION
  • DOCKER_MYSQL_VERSION
  • DOCKER_NODE_VERSION
  • DOCKER_YARN_PATH

User vars (defined in a local .env file).

  • DOCKER_SHARED_PATH
  • DOCKER_PROJECT_PATH
  • DOCKER_ATTACHED_MODE
  • DOCKER_PHP_COMMAND

The goal here is to move variables out of the 3 core docker files so that:

  • Easier to update the core docker files across projects.
  • Easier to update user/project docker config.
  • More obvious where user/project docker config is stored (and which is which).

The DOCKER_PROJECT_PATH is specifically to separate project data and avoid issues like muddled logs, or using different mysql versions. The shared path still exists for the composer-cache, etc.

New flags for du.sh:

  • -s Stops all running containers before starting new containers.
  • -k Kills all running containers before starting new containers.
  • -r Removes all stopped containers before starting new containers.
  • -p Pulls down latest images for new containers before starting them.
  • -c Cancel starting containers (like doing 'ctrl+c' right before containers start).

You can combine these flags and each flag will be executed in the given order.

Common uses:

  • ./du.sh -s when swapping projects (or -k when you don't care to retain container states).
  • ./du.sh -kr when you want to reset the container environment.
  • ./du.sh -p when starting a project you haven't used in a while.
  • ./du.sh -pc when you want to update a project's images, but not start the containers.

TEMPLATE

x.x.x (tag here)

Author: Name

Upgrading: (instruction on moving to this version)

  • Point 1.
  • Point 2.

Fixes: (was broken, now fixed)

  • Point 1.
  • Point 2.

Updates: (was working, now working differently)

  • Point 1.
  • Point 2.

Renamed: (name changed, affecting usage)

  • Point 1.
  • Point 2.

Features: (didn't exist, now does)

  • Feature 1.
  • Feature 2.

Feature 1

Text about feature 1.

Feature 2

Text about feature 2.