Minor edits

- Moved dates to be consistent with other release notes - Made grammar a little more consistent
2019-03-29 14:00:35 -07:00 · 2019-03-29 14:00:35 -07:00 · 74d28c880f
parent cc10460056
commit 74d28c880f
1 changed files with 144 additions and 83 deletions
--- a/release-notes/docker-compose.md
+++ b/release-notes/docker-compose.md
@ -5,32 +5,32 @@ keywords: release notes, compose
 toc_max: 2
 ---

-1.24.0 (2019-03-28)
-------------------
+## 1.24.0 
+(2019-03-28)

 ### Features

 - Added support for connecting to the Docker Engine using the `ssh` protocol.

- Added a `--all` flag to `docker-compose ps` to include stopped one-off containers
+- Added an `--all` flag to `docker-compose ps` to include stopped one-off containers
  in the command's output.

- Add bash completion for `ps --all|-a`
+- Added bash completion for `ps --all|-a`.

- Support for credential_spec
+- Added support for credential_spec.

- Add `--parallel` to `docker build`'s options in `bash` and `zsh` completion
+- Added `--parallel` to `docker build`'s options in `bash` and `zsh` completion.

-### Bugfixes
+### Bug Fixes

 - Fixed a bug where some valid credential helpers weren't properly handled by Compose
  when attempting to pull images from private registries.

 - Fixed an issue where the output of `docker-compose start` before containers were created
-  was misleading
+  was misleading.

- To match the Docker CLI behavior and to avoid confusing issues, Compose will no longer
-  accept whitespace in variable names sourced from environment files.
+- Compose will no longer accept whitespace in variable names sourced from environment files. 
+  This matches the Docker CLI behavior.

 - Compose will now report a configuration error if a service attempts to declare
  duplicate mount points in the volumes section.
@ -44,27 +44,27 @@ toc_max: 2
 - Fixed an issue that caused some container events to not appear in the output of
  the `docker-compose events` command.

- Missing images will no longer stop the execution of `docker-compose down` commands
-  (a warning will be displayed instead).
+- Missing images will no longer stop the execution of `docker-compose down` commands. A warning is 
+  now displayed instead.

- Force `virtualenv` version for macOS CI
+- Force `virtualenv` version for macOS CI.

- Fix merging of compose files when network has `None` config
+- Fixed merging of Compose files when network has `None` config.

- Fix `CTRL+C` issues by enabling `bootloader_ignore_signals` in `pyinstaller`
+- Fixed `CTRL+C` issues by enabling `bootloader_ignore_signals` in `pyinstaller`.

- Bump `docker-py` version to `3.7.2` to fix SSH and proxy config issues
+- Bumped `docker-py` version to `3.7.2` to fix SSH and proxy configuration issues.

- Fix release script and some typos on release documentation
+- Fixed release script and some typos on release documentation.

-1.23.2 (2018-11-28)
-------------------
+## 1.23.2 
+(2018-11-28)

-### Bugfixes
+### Bug Fixes

 - Reverted a 1.23.0 change that appended random strings to container names
  created by `docker-compose up`, causing addressability issues.
-  Note: Containers created by `docker-compose run` will continue to use
+  > **Note**: Containers created by `docker-compose run` will continue to use
  randomly generated names to avoid collisions during parallel runs.

 - Fixed an issue where some `dockerfile` paths would fail unexpectedly when
@ -81,7 +81,8 @@ toc_max: 2
 - Fixed a bug where some invalid Compose files would raise an uncaught
  exception during validation.

-## 1.23.1 (2018-11-01)
+## 1.23.1 
+(2018-11-01)

 ### Bug Fixes

@ -91,7 +92,8 @@ toc_max: 2
 - Fixed an issue where the behavior of the `--project-directory` flag would
  vary depending on which subcommand was used.

-## 1.23.0 (2018-10-30)
+## 1.23.0 
+(2018-10-30)

 ### Important note

@ -165,7 +167,8 @@ naming scheme accordingly before upgrading.
 - The `zsh` completion script has been updated with new options, and no
  longer suggests container names where service names are expected.

-## 1.22.0 (2018-07-17)
+## 1.22.0 
+(2018-07-17)

 ### New features

@ -218,14 +221,16 @@ naming scheme accordingly before upgrading.
 - Fixed a bug that caused auth values in legacy `.dockercfg` files to be ignored
 - `docker-compose build` will no longer attempt to create image names starting with an invalid character

-## 1.21.2 (2018-05-03)
+## 1.21.2 
+(2018-05-03)

 ### Bug Fixes

 - Fixed a bug where the ip_range attribute in IPAM configs was prevented
  from passing validation

-## 1.21.1 (2018-04-27)
+## 1.21.1 
+(2018-04-27)

 ### Bug Fixes

@ -250,7 +255,8 @@ naming scheme accordingly before upgrading.
  elements with some v3.2 files, triggering errors at the Engine level during
  deployment.

-## 1.21.0 (2018-04-11)
+## 1.21.0 
+(2018-04-11)

 ### New features

@ -313,7 +319,8 @@ naming scheme accordingly before upgrading.
  recognized as inexistent by Compose, interrupting otherwise valid
  operations.

-## 1.20.0 (2018-03-20)
+## 1.20.0 
+(2018-03-20)

 ### New features

@ -399,7 +406,8 @@ naming scheme accordingly before upgrading.

 - Fixed an encoding bug when streaming build progress

-## 1.19.0 (2018-02-07)
+## 1.19.0 
+(2018-02-07)

 ### Breaking changes

@ -491,7 +499,8 @@ naming scheme accordingly before upgrading.
  containing scalar types (number, boolean) now get automatically converted
  to strings

-## 1.18.0 (2017-12-18)
+## 1.18.0 
+(2017-12-18)

 ### New features

@ -573,7 +582,8 @@ naming scheme accordingly before upgrading.
 - The CLI now explicit prevents using `-d` and `--timeout` together
  in `docker-compose up`

-## 1.17.0 (2017-11-01)
+## 1.17.0 
+(2017-11-01)

 ### New features

@ -630,7 +640,8 @@ naming scheme accordingly before upgrading.
 - Fixed an issue where networks with identical names would sometimes be
  created when running `up` commands concurrently.

-## 1.16.0 (2017-08-31)
+## 1.16.0 
+(2017-08-31)

 ### New features

@ -689,7 +700,8 @@ naming scheme accordingly before upgrading.
 - Fixed the output of `docker-compose config` when a port definition used
  `0` as the value for the published port

-## 1.15.0 (2017-07-26)
+## 1.15.0 
+(2017-07-26)

 ### New features

@ -735,7 +747,8 @@ naming scheme accordingly before upgrading.
 - Fixed an issue preventing `up` operations on a previously created stack on
  Windows Engine.

-## 1.14.0 (2017-06-19)
+## 1.14.0 
+(2017-06-19)

 ### New features

@ -789,7 +802,8 @@ naming scheme accordingly before upgrading.
 - Fixed a bug where the output of `docker-compose config` would sometimes
  contain invalid port definitions

-## 1.13.0 (2017-05-02)
+## 1.13.0 
+(2017-05-02)

 ### Breaking changes

@ -844,7 +858,8 @@ naming scheme accordingly before upgrading.
  `volumes` would result in an invalid config state


-## 1.12.0 (2017-04-04)
+## 1.12.0 
+(2017-04-04)

 ### New features

@ -940,7 +955,8 @@ naming scheme accordingly before upgrading.
 - Fixed an issue where Compose would not pick up on the value of
  COMPOSE_TLS_VERSION when used in combination with command-line TLS flags

-## 1.11.2 (2017-02-17)
+## 1.11.2 
+(2017-02-17)

 ### Bug Fixes

@ -960,14 +976,16 @@ naming scheme accordingly before upgrading.
 - Fixed an issue where recursive wildcard patterns `**` were not being
  recognized in `.dockerignore` files.

-## 1.11.1 (2017-02-09)
+## 1.11.1 
+(2017-02-09)

 ### Bug Fixes

 - Fixed a bug where the 3.1 file format was not being recognized as valid
  by the Compose parser

-## 1.11.0 (2017-02-08)
+## 1.11.0 
+(2017-02-08)

 ### New Features

@ -990,7 +1008,8 @@ naming scheme accordingly before upgrading.
 - Fixed an issue where the `pid` entry in a service definition was being
  ignored when using multiple Compose files.

-## 1.10.1 (2017-02-01)
+## 1.10.1 
+(2017-02-01)

 ### Bug Fixes

@ -1012,7 +1031,8 @@ naming scheme accordingly before upgrading.
 - Fixed a bug where Compose would occasionally crash while streaming logs
  when containers would stop or restart

-## 1.10.0 (2017-01-18)
+## 1.10.0 
+(2017-01-18)

 ### New Features

@ -1059,7 +1079,8 @@ naming scheme accordingly before upgrading.
  being parsed correctly on Windows


-## 1.9.0 (2016-11-16)
+## 1.9.0 
+(2016-11-16)

 **Breaking changes**

@ -1116,7 +1137,8 @@ naming scheme accordingly before upgrading.
  mismatch for overlay networks.


-## 1.8.1 (2016-09-22)
+## 1.8.1 
+(2016-09-22)

 ### Bug Fixes

@ -1157,7 +1179,8 @@ naming scheme accordingly before upgrading.
  a connection timeout.


-## 1.8.0 (2016-06-14)
+## 1.8.0 
+(2016-06-14)

 ### Breaking Changes

@ -1218,7 +1241,8 @@ naming scheme accordingly before upgrading.
  descriptive error messages when something goes wrong.


-## 1.7.1 (2016-05-04)
+## 1.7.1 
+(2016-05-04)

 ### Bug Fixes

@ -1258,7 +1282,8 @@ naming scheme accordingly before upgrading.
  location as the Compose file.


-## 1.7.0 (2016-04-13)
+## 1.7.0 
+(2016-04-13)

 ### Breaking Changes

@ -1345,12 +1370,14 @@ naming scheme accordingly before upgrading.
 -   Fixed a bug where empty values for build args would cause file validation
    to fail.

-## 1.6.2 (2016-02-23)
+## 1.6.2 
+(2016-02-23)

 -   Fixed a bug where connecting to a TLS-enabled Docker Engine would fail with
    a certificate verification error.

-## 1.6.1 (2016-02-23)
+## 1.6.1 
+(2016-02-23)

 ### Bug Fixes

@ -1404,7 +1431,8 @@ naming scheme accordingly before upgrading.
    as a value in a mapping.


-## 1.6.0 (2016-01-15)
+## 1.6.0 
+(2016-01-15)

 ### Major Features:

@ -1520,7 +1548,8 @@ naming scheme accordingly before upgrading.
    non-standard logging driver (or none at all).


-## 1.5.2 (2015-12-03)
+## 1.5.2 
+(2015-12-03)

 -   Fixed a bug which broke the use of `environment` and `env_file` with
    `extends`, and caused environment keys without values to have a `None`
@ -1541,7 +1570,8 @@ naming scheme accordingly before upgrading.
 -   Improved the validation of the `expose` option


-### 1.5.1 (2015-11-12)
+## 1.5.1 
+(2015-11-12)

 -   Add the `--force-rm` option to `build`.

@ -1593,7 +1623,8 @@ naming scheme accordingly before upgrading.
    error message.


-## 1.5.0 (2015-11-03)
+## 1.5.0 
+(2015-11-03)

 ### Breaking changes

@ -1693,12 +1724,14 @@ https://github.com/docker/compose/blob/8cc8e61/docs/compose-file.md#variable-sub
 -   `docker-compose build` can now be run successfully against a Swarm cluster.


-## 1.4.2 (2015-09-22)
+## 1.4.2 
+(2015-09-22)

 -  Fixed a regression in the 1.4.1 release that would cause `docker-compose up`
   without the `-d` option to exit immediately.

-## 1.4.1 (2015-09-10)
+## 1.4.1 
+(2015-09-10)

 ### Bug fixes

@ -1713,7 +1746,8 @@ https://github.com/docker/compose/blob/8cc8e61/docs/compose-file.md#variable-sub
    the configuration had not changed.


-## 1.4.0 (2015-08-04)
+## 1.4.0 
+(2015-08-04)

 -   By default, `docker-compose up` now only recreates containers for services whose configuration has changed since they were created. This should result in a dramatic speed-up for many applications.

@ -1751,14 +1785,16 @@ https://github.com/docker/compose/blob/8cc8e61/docs/compose-file.md#variable-sub

 Thanks @mnowster, @dnephin, @ekristen, @funkyfuture, @jeffk and @lukemarsden!

-## 1.3.3 (2015-07-15)
+## 1.3.3 
+(2015-07-15)

 ### Regression fixes

 - When stopping containers gracefully, Compose was setting the timeout to 0, effectively forcing a SIGKILL every time.
 - Compose would sometimes crash depending on the formatting of container data returned from the Docker API.

-## 1.3.2 (2015-07-14)
+## 1.3.2 
+(2015-07-14)

 ### Bug fixes

@ -1772,7 +1808,8 @@ Thanks @mnowster, @dnephin, @ekristen, @funkyfuture, @jeffk and @lukemarsden!

 Thanks @dano, @josephpage, @kevinsimper, @lieryan, @phemmer, @soulrebel and @sschepens!

-## 1.3.1 (2015-06-21)
+## 1.3.1 
+(2015-06-21)

 ### Bug fixes

@ -1780,7 +1817,8 @@ Thanks @dano, @josephpage, @kevinsimper, @lieryan, @phemmer, @soulrebel and @ssc
 - `docker-compose help migrate-to-labels` failed with an error.
 - If no network mode was specified, Compose would set it to "bridge", rather than allowing the Docker daemon to use its configured default network mode.

-## 1.3.0 (2015-06-18)
+## 1.3.0 
+(2015-06-18)

 ### Important notes

@ -1813,7 +1851,7 @@ Several new configuration keys have been added to `docker-compose.yml`:
 - `security_opt`, like `docker run --security-opt`, lets you specify [security options](https://docs.docker.com/engine/reference/run/#security-configuration).
 - `log_driver`, like `docker run --log-driver`, lets you specify a [log driver](https://docs.docker.com/engine/reference/run/#logging-drivers-log-driver).

-### Bug fixes
+### Bug Fixes

 - The output of `docker-compose run` was sometimes truncated, especially when running under Jenkins.
 - A service's volumes would sometimes not update after volume configuration was changed in `docker-compose.yml`.
@ -1824,7 +1862,8 @@ Several new configuration keys have been added to `docker-compose.yml`:

 Thanks @ahromis, @albers, @aleksandr-vin, @antoineco, @ccverak, @chernjie, @dnephin, @edmorley, @fordhurley, @josephpage, @KyleJamesWalker, @lsowen, @mchasal, @noironetworks, @sdake, @sdurrheimer, @sherter, @stephenlawrence, @thaJeztah, @thieman, @turtlemonvh, @twhiteman, @vdemeester, @xuxinkun and @zwily!

-## 1.2.0 (2015-04-16)
+## 1.2.0 
+(2015-04-16)

 - `docker-compose.yml` now supports an `extends` option, which enables a service to inherit configuration from another service in another configuration file. This is really good for sharing common configuration between apps, or for configuring the same app for different environments. Here's the [documentation](https://github.com/docker/compose/blob/master/docs/yml.md#extends).

@ -1846,7 +1885,8 @@ Thanks @ahromis, @albers, @aleksandr-vin, @antoineco, @ccverak, @chernjie, @dnep

 Thanks, @abesto, @albers, @alunduil, @dnephin, @funkyfuture, @gilclark, @IanVS, @KingsleyKelly, @knutwalker, @thaJeztah and @vmalloc!

-## 1.1.0 (2015-02-25)
+## 1.1.0 
+(2015-02-25)

 Fig has been renamed to Docker Compose, or just Compose for short. This has several implications for you:

@ -1878,13 +1918,15 @@ Besides that, there’s a lot of new stuff in this release:

 Thanks @dnephin, @squebe, @jbalonso, @raulcd, @benlangfield, @albers, @ggtools, @bersace, @dtenenba, @petercv, @drewkett, @TFenby, @paulRbr, @Aigeruth and @salehe!

-## 1.0.1 (2014-11-04)
+## 1.0.1 
+(2014-11-04)

 - Added an `--allow-insecure-ssl` option to allow `fig up`, `fig run` and `fig pull` to pull from insecure registries.
 - Fixed `fig run` not showing output in Jenkins.
 - Fixed a bug where Fig couldn't build Dockerfiles with ADD statements pointing at URLs.

-## 1.0.0 (2014-10-16)
+## 1.0.0 
+(2014-10-16)

 The highlights:

@ -1927,7 +1969,8 @@ Other things:

 Thanks @dnephin, @d11wtq, @marksteve, @rubbish, @jbalonso, @timfreund, @alunduil, @mieciu, @shuron, @moss, @suzaku and @chmouel! Whew.

-## 0.5.2 (2014-07-28)
+## 0.5.2 
+(2014-07-28)

 - Added a `--no-cache` option to `fig build`, which bypasses the cache just like `docker build --no-cache`.
 - Fixed the `dns:` fig.yml option, which was causing fig to error out.
@ -1937,7 +1980,8 @@ Thanks @dnephin, @d11wtq, @marksteve, @rubbish, @jbalonso, @timfreund, @alunduil
 Thanks @dnephin and @marksteve!


-## 0.5.1 (2014-07-11)
+## 0.5.1 
+(2014-07-11)

 - If a service has a command defined, `fig run [service]` with no further arguments will run it.
 - The project name now defaults to the directory containing fig.yml, not the current working directory (if they're different)
@ -1947,7 +1991,8 @@ Thanks @dnephin and @marksteve!
 Thanks @ryanbrainard and @d11wtq!


-## 0.5.0 (2014-07-11)
+## 0.5.0 
+(2014-07-11)

 - Fig now starts links when you run `fig run` or `fig up`.

@ -1984,17 +2029,20 @@ Thanks @ryanbrainard and @d11wtq!
 Thanks to @d11wtq, @ryanbrainard, @rail44, @j0hnsmith, @binarin, @Elemecca, @mozz100 and @marksteve for their help with this release!


-## 0.4.2 (2014-06-18)
+## 0.4.2 
+(2014-06-18)

 - Fix various encoding errors when using `fig run`, `fig up` and `fig build`.

-## 0.4.1 (2014-05-08)
+## 0.4.1 
+(2014-05-08)

 - Add support for Docker 0.11.0. (Thanks @marksteve!)
 - Make project name configurable. (Thanks @jefmathiot!)
 - Return correct exit code from `fig run`.

-## 0.4.0 (2014-04-29)
+## 0.4.0 
+(2014-04-29)

 - Support Docker 0.9 and 0.10
 - Display progress bars correctly when pulling images (no more ski slopes)
@ -2005,18 +2053,21 @@ Thanks to @d11wtq, @ryanbrainard, @rail44, @j0hnsmith, @binarin, @Elemecca, @moz
 - Handle UTF-8 correctly when streaming `fig build/run/up` output (thanks @mauvm and @shanejonas!)
 - Error message improvements

-## 0.3.2 (2014-03-05)
+## 0.3.2 
+(2014-03-05)

 - Added an `--rm` option to `fig run`. (Thanks @marksteve!)
 - Added an `expose` option to `fig.yml`.

-## 0.3.1 (2014-03-04)
+## 0.3.1 
+(2014-03-04)

 - Added contribution instructions. (Thanks @kvz!)
 - Fixed `fig rm` throwing an error.
 - Fixed a bug in `fig ps` on Docker 0.8.1 when there is a container with no command.

-## 0.3.0 (2014-03-03)
+## 0.3.0 
+(2014-03-03)

 - We now ship binaries for OS X and Linux. No more having to install with Pip!
 - Add `-f` flag to specify alternate `fig.yml` files
@ -2028,7 +2079,8 @@ Thanks to @d11wtq, @ryanbrainard, @rail44, @j0hnsmith, @binarin, @Elemecca, @moz

 Thanks @marksteve, @Gazler and @teozkr!

-## 0.2.2 (2014-02-17)
+## 0.2.2 
+(2014-02-17)

 - Resolve dependencies using Cormen/Tarjan topological sort
 - Fix `fig up` not printing log output
@ -2037,11 +2089,13 @@ Thanks @marksteve, @Gazler and @teozkr!

 Thanks to @barnybug and @dustinlacewell for their work on this release.

-## 0.2.1 (2014-02-04)
+## 0.2.1 
+(2014-02-04)

 - General improvements to error reporting (#77, #79)

-## 0.2.0 (2014-01-31)
+## 0.2.0 
+(2014-01-31)

 - Link services to themselves so run commands can access the running service. (#67)
 - Much better documentation.
@ -2050,26 +2104,31 @@ Thanks to @barnybug and @dustinlacewell for their work on this release.

 Big thanks to @cameronmaske, @mrchrisadams and @damianmoore for their help with this release.

-## 0.1.4 (2014-01-27)
+## 0.1.4 
+(2014-01-27)

 - Add a link alias without the project name. This makes the environment variables a little shorter: `REDIS_1_PORT_6379_TCP_ADDR`. (#54)

-## 0.1.3 (2014-01-23)
+## 0.1.3 
+(2014-01-23)

 - Fix ports sometimes being configured incorrectly. (#46)
 - Fix log output sometimes not displaying. (#47)

-## 0.1.2 (2014-01-22)
+## 0.1.2 
+(2014-01-22)

 - Add `-T` option to `fig run` to disable pseudo-TTY. (#34)
 - Fix `fig up` requiring the ubuntu image to be pulled to recreate containers. (#33) Thanks @cameronmaske!
 - Improve reliability, fix arrow keys and fix a race condition in `fig run`. (#34, #39, #40)

-## 0.1.1 (2014-01-17)
+## 0.1.1 
+(2014-01-17)

 - Fix bug where ports were not exposed correctly (#29). Thanks @dustinlacewell!

-## 0.1.0 (2014-01-16)
+## 0.1.0 
+(2014-01-16)

 - Containers are recreated on each `fig up`, ensuring config is up-to-date with `fig.yml` (#2)
 - Add `fig scale` command (#9)
@ -2083,7 +2142,8 @@ Big thanks to @cameronmaske, @mrchrisadams and @damianmoore for their help with

 Big thanks to @tomstuart, @EnTeQuAk, @schickling, @aronasorman and @GeoffreyPlitt.

-## 0.0.2 (2014-01-02)
+## 0.0.2 
+(2014-01-02)

 - Improve documentation
 - Try to connect to Docker on `tcp://localdocker:4243` and a UNIX socket in addition to `localhost`.
@ -2091,6 +2151,7 @@ Big thanks to @tomstuart, @EnTeQuAk, @schickling, @aronasorman and @GeoffreyPlit
 - Add confirmation prompt to `fig rm`
 - Add `fig build` command

-## 0.0.1 (2013-12-20)
+## 0.0.1 
+(2013-12-20)

 Initial release.