From a7c311c396f9ed6cb3b98a836499fc4b84a294e0 Mon Sep 17 00:00:00 2001 From: Angelo Cali Date: Tue, 20 Feb 2024 01:26:46 +0100 Subject: [PATCH 1/2] add method alias down for downAll --- CHANGELOG.md | 169 +++++++++++++++++++++++---------------------------- src/v2.ts | 3 + 2 files changed, 78 insertions(+), 94 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 23ba6448..6193ceb4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,189 +2,169 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +### Bug Fixes + +- Adds `down()` as alias for `downAll()` to support compatbility with existing packages which use this project + ### [0.24.5](https://github.com/PDMLab/docker-compose/compare/v0.24.4...v0.24.5) (2024-02-19) ### [0.24.4](https://github.com/PDMLab/docker-compose/compare/v0.24.3...v0.24.4) (2024-02-19) ### [0.24.3](https://github.com/PDMLab/docker-compose/compare/v0.24.2...v0.24.3) (2023-10-30) - ### Features -* ps supports json format ([4498eb4](https://github.com/PDMLab/docker-compose/commit/4498eb481c52f852247342b495ff66c5b465f895)) +- ps supports json format ([4498eb4](https://github.com/PDMLab/docker-compose/commit/4498eb481c52f852247342b495ff66c5b465f895)) ### [0.24.2](https://github.com/PDMLab/docker-compose/compare/v0.24.1...v0.24.2) (2023-07-27) - ### Bug Fixes -* **ci:** shadow ci command using yarn ([bf0d1b6](https://github.com/PDMLab/docker-compose/commit/bf0d1b6a7ebc80b0ac158bbffc277b3c118545df)) +- **ci:** shadow ci command using yarn ([bf0d1b6](https://github.com/PDMLab/docker-compose/commit/bf0d1b6a7ebc80b0ac158bbffc277b3c118545df)) ### [0.24.1](https://github.com/PDMLab/docker-compose/compare/v0.24.0...v0.24.1) (2023-05-14) - ### Bug Fixes -* Remove unnecessary console.log in v2 api ([#241](https://github.com/PDMLab/docker-compose/issues/241)) ([75ab935](https://github.com/PDMLab/docker-compose/commit/75ab935dcdf5c32cf44643d4d74ba6b30620a31a)) +- Remove unnecessary console.log in v2 api ([#241](https://github.com/PDMLab/docker-compose/issues/241)) ([75ab935](https://github.com/PDMLab/docker-compose/commit/75ab935dcdf5c32cf44643d4d74ba6b30620a31a)) ## [0.24.0](https://github.com/PDMLab/docker-compose/compare/v0.23.19...v0.24.0) (2023-04-28) - ### Features -* support docker compose v2 plugin version ([#228](https://github.com/PDMLab/docker-compose/issues/228)) ([95250be](https://github.com/PDMLab/docker-compose/commit/95250beeee1b5a1f9433138870392b611a3eec93)) +- support docker compose v2 plugin version ([#228](https://github.com/PDMLab/docker-compose/issues/228)) ([95250be](https://github.com/PDMLab/docker-compose/commit/95250beeee1b5a1f9433138870392b611a3eec93)) ### [0.23.20-preview.0](https://github.com/PDMLab/docker-compose/compare/v0.23.19...v0.23.20-preview.0) (2023-04-27) - ### Features -* support docker compose v2 plugin version ([81e72e9](https://github.com/PDMLab/docker-compose/commit/81e72e9985aba05474463306852501287ad32680)) - +- support docker compose v2 plugin version ([81e72e9](https://github.com/PDMLab/docker-compose/commit/81e72e9985aba05474463306852501287ad32680)) ### Bug Fixes -* expect volume name to match changed folder name ([85c4c15](https://github.com/PDMLab/docker-compose/commit/85c4c150ce5191c95116e98145e2d3c75604a4a4)) -* **build:** exclude old tests temporarily ([36d543d](https://github.com/PDMLab/docker-compose/commit/36d543db56822be95c9cd31eaa890a4c46e789a4)) -* **lint:** no-useless-escape for \" characters ([fcabbc2](https://github.com/PDMLab/docker-compose/commit/fcabbc2ea7c7d42f15f45a26badab9fe73030a6c)) -* **lint:** remove jest plugin reference ([892e6db](https://github.com/PDMLab/docker-compose/commit/892e6db60302ef734e5b42b74da6f583c1fb9e52)) +- expect volume name to match changed folder name ([85c4c15](https://github.com/PDMLab/docker-compose/commit/85c4c150ce5191c95116e98145e2d3c75604a4a4)) +- **build:** exclude old tests temporarily ([36d543d](https://github.com/PDMLab/docker-compose/commit/36d543db56822be95c9cd31eaa890a4c46e789a4)) +- **lint:** no-useless-escape for \" characters ([fcabbc2](https://github.com/PDMLab/docker-compose/commit/fcabbc2ea7c7d42f15f45a26badab9fe73030a6c)) +- **lint:** remove jest plugin reference ([892e6db](https://github.com/PDMLab/docker-compose/commit/892e6db60302ef734e5b42b74da6f583c1fb9e52)) ### [0.23.19](https://github.com/PDMLab/docker-compose/compare/v0.23.18...v0.23.19) (2023-02-05) ### [0.23.18](https://github.com/PDMLab/docker-compose/compare/v0.23.17...v0.23.18) (2023-01-24) - ### Bug Fixes -* add stopMany to default exports ([ff914e9](https://github.com/PDMLab/docker-compose/commit/ff914e910cb963b8fa7f283a1f51cb66fae0f52b)) +- add stopMany to default exports ([ff914e9](https://github.com/PDMLab/docker-compose/commit/ff914e910cb963b8fa7f283a1f51cb66fae0f52b)) ### [0.23.17](https://github.com/PDMLab/docker-compose/compare/v0.23.16...v0.23.17) (2022-01-18) - ### Bug Fixes -* ps --services trim on undefined ([#201](https://github.com/PDMLab/docker-compose/issues/201)) ([5df547e](https://github.com/PDMLab/docker-compose/commit/5df547e0af97bc6ba2ac96aab26eb5bf4b60e2b8)) +- ps --services trim on undefined ([#201](https://github.com/PDMLab/docker-compose/issues/201)) ([5df547e](https://github.com/PDMLab/docker-compose/commit/5df547e0af97bc6ba2ac96aab26eb5bf4b60e2b8)) ### [0.23.16](https://github.com/PDMLab/docker-compose/compare/v0.23.15...v0.23.16) (2022-01-16) - ### Features -* stop many ([#200](https://github.com/PDMLab/docker-compose/issues/200)) ([f10a9b6](https://github.com/PDMLab/docker-compose/commit/f10a9b610160c4ac06d0d38cbd9db4a6fe7761c9)) +- stop many ([#200](https://github.com/PDMLab/docker-compose/issues/200)) ([f10a9b6](https://github.com/PDMLab/docker-compose/commit/f10a9b610160c4ac06d0d38cbd9db4a6fe7761c9)) ### [0.23.15](https://github.com/PDMLab/docker-compose/compare/v0.23.14...v0.23.15) (2022-01-14) - ### Bug Fixes -* **#178:** fix quiet trim issue, add tests ([#197](https://github.com/PDMLab/docker-compose/issues/197)) ([2016bc7](https://github.com/PDMLab/docker-compose/commit/2016bc75db9996155d61f3d7f93c98c5fb960df1)) +- **#178:** fix quiet trim issue, add tests ([#197](https://github.com/PDMLab/docker-compose/issues/197)) ([2016bc7](https://github.com/PDMLab/docker-compose/commit/2016bc75db9996155d61f3d7f93c98c5fb960df1)) ### [0.23.14](https://github.com/PDMLab/docker-compose/compare/v0.23.13...v0.23.14) (2021-11-29) - ### Features -* passing callback to report progress ([#191](https://github.com/PDMLab/docker-compose/issues/191)) ([f60e4d5](https://github.com/PDMLab/docker-compose/commit/f60e4d5a186ea3ca0b99e8443e1c4006d75be5a7)) +- passing callback to report progress ([#191](https://github.com/PDMLab/docker-compose/issues/191)) ([f60e4d5](https://github.com/PDMLab/docker-compose/commit/f60e4d5a186ea3ca0b99e8443e1c4006d75be5a7)) ### [0.23.13](https://github.com/PDMLab/docker-compose/compare/v0.23.12...v0.23.13) (2021-07-20) - ### Features -* single container pause and unpause added ([5921b51](https://github.com/PDMLab/docker-compose/commit/5921b51977cbd51ffcb1def458738ccfccbe1dd9)) - +- single container pause and unpause added ([5921b51](https://github.com/PDMLab/docker-compose/commit/5921b51977cbd51ffcb1def458738ccfccbe1dd9)) ### Bug Fixes -* now lints correctly ([74b4d6e](https://github.com/PDMLab/docker-compose/commit/74b4d6ea22d7e1b9ebbbbe9874e5314b7adfa31a)) +- now lints correctly ([74b4d6e](https://github.com/PDMLab/docker-compose/commit/74b4d6ea22d7e1b9ebbbbe9874e5314b7adfa31a)) ### [0.23.12](https://github.com/PDMLab/docker-compose/compare/v0.23.11...v0.23.12) (2021-06-06) - ### Features -* **dx:** add default export ([c4b6087](https://github.com/PDMLab/docker-compose/commit/c4b60872aecfdc6610e9b2141a45ea7785820af7)) +- **dx:** add default export ([c4b6087](https://github.com/PDMLab/docker-compose/commit/c4b60872aecfdc6610e9b2141a45ea7785820af7)) ### [0.23.11](https://github.com/PDMLab/docker-compose/compare/v0.23.10...v0.23.11) (2021-06-04) ### [0.23.10](https://github.com/PDMLab/docker-compose/compare/v0.23.9...v0.23.10) (2021-05-11) - ### Bug Fixes -* fix mapping ipv6-based port mappings ([53fb971](https://github.com/PDMLab/docker-compose/commit/53fb97196f3cf0ebb229d127e9b630c863eaf8fc)) -* fix mapping ipv6-based port mappings ([6dec0c6](https://github.com/PDMLab/docker-compose/commit/6dec0c6bb6220b06eff188a26220b405d632bed3)) -* fix mapping ipv6-based port mappings ([dbdb900](https://github.com/PDMLab/docker-compose/commit/dbdb9008f25d237254312d79382e342d03f4c5bb)) -* fix mapping ipv6-based port mappings ([8aa8465](https://github.com/PDMLab/docker-compose/commit/8aa846553c2d045f610392bf38569fb3579b9aa6)) -* fix mapping ipv6-based port mappings ([21b63cb](https://github.com/PDMLab/docker-compose/commit/21b63cbc53635ee8532c388e57f4552f1b3ae6e3)) -* fix mapping ipv6-based port mappings ([48c9f08](https://github.com/PDMLab/docker-compose/commit/48c9f0841af2bbcb8ec666a38eee3ab8236304d0)) -* fix mapping ipv6-based port mappings ([e7013df](https://github.com/PDMLab/docker-compose/commit/e7013dfab10e4e369ee076b465c40a5bcb50802b)) +- fix mapping ipv6-based port mappings ([53fb971](https://github.com/PDMLab/docker-compose/commit/53fb97196f3cf0ebb229d127e9b630c863eaf8fc)) +- fix mapping ipv6-based port mappings ([6dec0c6](https://github.com/PDMLab/docker-compose/commit/6dec0c6bb6220b06eff188a26220b405d632bed3)) +- fix mapping ipv6-based port mappings ([dbdb900](https://github.com/PDMLab/docker-compose/commit/dbdb9008f25d237254312d79382e342d03f4c5bb)) +- fix mapping ipv6-based port mappings ([8aa8465](https://github.com/PDMLab/docker-compose/commit/8aa846553c2d045f610392bf38569fb3579b9aa6)) +- fix mapping ipv6-based port mappings ([21b63cb](https://github.com/PDMLab/docker-compose/commit/21b63cbc53635ee8532c388e57f4552f1b3ae6e3)) +- fix mapping ipv6-based port mappings ([48c9f08](https://github.com/PDMLab/docker-compose/commit/48c9f0841af2bbcb8ec666a38eee3ab8236304d0)) +- fix mapping ipv6-based port mappings ([e7013df](https://github.com/PDMLab/docker-compose/commit/e7013dfab10e4e369ee076b465c40a5bcb50802b)) ### [0.23.9](https://github.com/PDMLab/docker-compose/compare/v0.23.8...v0.23.9) (2021-05-08) - ### Features -* Add execPath option to set path to docker-compose executable ([58f09f4](https://github.com/PDMLab/docker-compose/commit/58f09f4c7414df5a6ee7af7f77d2af297d84d6c1)) +- Add execPath option to set path to docker-compose executable ([58f09f4](https://github.com/PDMLab/docker-compose/commit/58f09f4c7414df5a6ee7af7f77d2af297d84d6c1)) ### [0.23.8](https://github.com/PDMLab/docker-compose/compare/v0.23.7...v0.23.8) (2021-04-15) - ### Bug Fixes -* ignore vuepress cache + temp files on release ([#148](https://github.com/PDMLab/docker-compose/issues/148)) ([e58387d](https://github.com/PDMLab/docker-compose/commit/e58387d82e4586f7a8156446f12c999c9a6f9f42)) +- ignore vuepress cache + temp files on release ([#148](https://github.com/PDMLab/docker-compose/issues/148)) ([e58387d](https://github.com/PDMLab/docker-compose/commit/e58387d82e4586f7a8156446f12c999c9a6f9f42)) ### [0.23.7](https://github.com/PDMLab/docker-compose/compare/v0.23.5...v0.23.7) (2021-04-14) - ### Features -* allow to pass docker compose configuration as string ([e8c14d3](https://github.com/PDMLab/docker-compose/commit/e8c14d318ce440ab02c858b1ca1dbeeb2985dc00)) -* make result for `config --services` command type safe ([6f105ca](https://github.com/PDMLab/docker-compose/commit/6f105ca16098ba8de11f85ec0d092130b65293e4)) -* make result for `config --volumes` command type safe ([51b20b4](https://github.com/PDMLab/docker-compose/commit/51b20b43d6eccac45653553437a546e4ccee51a6)) -* make result for `config` command type safe ([a2f5a4e](https://github.com/PDMLab/docker-compose/commit/a2f5a4ec0eee8fcbd60fa12f969b8eb83a4730fb)) -* make result for `port` command type safe ([70a98f4](https://github.com/PDMLab/docker-compose/commit/70a98f473b7bd46f0aa03c1a4334fa2abf6c3455)) -* make result for `ps` command type safe ([880d252](https://github.com/PDMLab/docker-compose/commit/880d2522b5777db30c48569a41dd09fb7e46a4b3)) -* make result for `version` command type safe ([a7da038](https://github.com/PDMLab/docker-compose/commit/a7da0380a8464bbd2efc2c16b70b67d4fdf77c24)) - +- allow to pass docker compose configuration as string ([e8c14d3](https://github.com/PDMLab/docker-compose/commit/e8c14d318ce440ab02c858b1ca1dbeeb2985dc00)) +- make result for `config --services` command type safe ([6f105ca](https://github.com/PDMLab/docker-compose/commit/6f105ca16098ba8de11f85ec0d092130b65293e4)) +- make result for `config --volumes` command type safe ([51b20b4](https://github.com/PDMLab/docker-compose/commit/51b20b43d6eccac45653553437a546e4ccee51a6)) +- make result for `config` command type safe ([a2f5a4e](https://github.com/PDMLab/docker-compose/commit/a2f5a4ec0eee8fcbd60fa12f969b8eb83a4730fb)) +- make result for `port` command type safe ([70a98f4](https://github.com/PDMLab/docker-compose/commit/70a98f473b7bd46f0aa03c1a4334fa2abf6c3455)) +- make result for `ps` command type safe ([880d252](https://github.com/PDMLab/docker-compose/commit/880d2522b5777db30c48569a41dd09fb7e46a4b3)) +- make result for `version` command type safe ([a7da038](https://github.com/PDMLab/docker-compose/commit/a7da0380a8464bbd2efc2c16b70b67d4fdf77c24)) ### Bug Fixes -* filter empty entries from `config --services` command ([ed91eba](https://github.com/PDMLab/docker-compose/commit/ed91eba770d3a32d82dda4e927d31ed4b6d01db4)) -* **test:** fix broken tests ([afb2b11](https://github.com/PDMLab/docker-compose/commit/afb2b1116b12c4800563e85adb15ebd39e030516)) +- filter empty entries from `config --services` command ([ed91eba](https://github.com/PDMLab/docker-compose/commit/ed91eba770d3a32d82dda4e927d31ed4b6d01db4)) +- **test:** fix broken tests ([afb2b11](https://github.com/PDMLab/docker-compose/commit/afb2b1116b12c4800563e85adb15ebd39e030516)) ### [0.23.6](https://github.com/PDMLab/docker-compose/compare/v0.23.5...v0.23.6) (2021-01-06) - ### Features -* allow to pass docker compose configuration as string ([e8c14d3](https://github.com/PDMLab/docker-compose/commit/e8c14d318ce440ab02c858b1ca1dbeeb2985dc00)) +- allow to pass docker compose configuration as string ([e8c14d3](https://github.com/PDMLab/docker-compose/commit/e8c14d318ce440ab02c858b1ca1dbeeb2985dc00)) ### [0.23.5](https://github.com/PDMLab/docker-compose/compare/v0.23.4...v0.23.5) (2020-07-10) - ### Bug Fixes -* update flags incompatible with detached mode ([c808fa2](https://github.com/PDMLab/docker-compose/commit/c808fa2b90b2fd5db239685d101ccaa554ad98cf)) +- update flags incompatible with detached mode ([c808fa2](https://github.com/PDMLab/docker-compose/commit/c808fa2b90b2fd5db239685d101ccaa554ad98cf)) ### [0.23.4](https://github.com/PDMLab/docker-compose/compare/v0.23.3...v0.23.4) (2020-04-23) - ### Features -* allow passing service names to `rm` function ([3a68db7](https://github.com/PDMLab/docker-compose/commit/3a68db75e3b879f12fe3c6cedbc9ad09a52914a5)) +- allow passing service names to `rm` function ([3a68db7](https://github.com/PDMLab/docker-compose/commit/3a68db75e3b879f12fe3c6cedbc9ad09a52914a5)) ### [0.23.3](https://github.com/PDMLab/docker-compose/compare/v0.23.2...v0.23.3) (2020-03-06) - ### Features -* add ability to pass --abort-on-container-exit flag to up methods ([e85af8c](https://github.com/PDMLab/docker-compose/commit/e85af8c092a54a3fb48519bb39956324bbef4fc2)) - +- add ability to pass --abort-on-container-exit flag to up methods ([e85af8c](https://github.com/PDMLab/docker-compose/commit/e85af8c092a54a3fb48519bb39956324bbef4fc2)) ### Bug Fixes -* reset jest set timeout to original value ([c4ed7ed](https://github.com/PDMLab/docker-compose/commit/c4ed7ed2de9c4c161518ab1d1fc50877df4c7fa2)) +- reset jest set timeout to original value ([c4ed7ed](https://github.com/PDMLab/docker-compose/commit/c4ed7ed2de9c4c161518ab1d1fc50877df4c7fa2)) ### [0.23.2](https://github.com/PDMLab/docker-compose/compare/v0.23.1...v0.23.2) (2019-12-31) @@ -194,103 +174,104 @@ All notable changes to this project will be documented in this file. See [standa ## :tada: Enhancements -* [#97](https://github.com/PDMLab/docker-compose/pull/97): - * Add a `version` function +- [#97](https://github.com/PDMLab/docker-compose/pull/97): + - Add a `version` function # 0.22.2 / 2019-08-31 ## :bug: Fixes -* [#94](https://github.com/PDMLab/docker-compose/pull/94): - * Fix a copy-paste typo for pull commands +- [#94](https://github.com/PDMLab/docker-compose/pull/94): + - Fix a copy-paste typo for pull commands # 0.22.1 / 2019-08-31 ## :tada: Enhancements -* [#93](https://github.com/PDMLab/docker-compose/pull/93): - * Add pull command methods to readme +- [#93](https://github.com/PDMLab/docker-compose/pull/93): + - Add pull command methods to readme ## :lock: Security Fixes -* [#92](https://github.com/PDMLab/docker-compose/pull/92): - * Fix `eslint-utils` security issue + +- [#92](https://github.com/PDMLab/docker-compose/pull/92): + - Fix `eslint-utils` security issue # 0.22.0 / 2019-08-30 ## :tada: Enhancements -* [#90](https://github.com/PDMLab/docker-compose/pull/90): - * Add `pullOne`, `pullMany` and `pullAll` methods +- [#90](https://github.com/PDMLab/docker-compose/pull/90): + - Add `pullOne`, `pullMany` and `pullAll` methods # 0.21.0 / 2019-08-15 ## :tada: Enhancements -* [#89](https://github.com/PDMLab/docker-compose/pull/89): - * Add `stopOne()` command +- [#89](https://github.com/PDMLab/docker-compose/pull/89): + - Add `stopOne()` command # 0.20.2 / 2019-07-30 ## :tada: Enhancements -* [#87](https://github.com/PDMLab/docker-compose/pull/87): - * Use proper `es2015` library (for Promises, etc.) in `tsconfig` +- [#87](https://github.com/PDMLab/docker-compose/pull/87): + - Use proper `es2015` library (for Promises, etc.) in `tsconfig` ## :bug: Fixes -* [#87](https://github.com/PDMLab/docker-compose/pull/87): - * Fix linting after build was called -* [#86](https://github.com/PDMLab/docker-compose/pull/86): - * Fix interfaces not being exposed in typings file +- [#87](https://github.com/PDMLab/docker-compose/pull/87): + - Fix linting after build was called +- [#86](https://github.com/PDMLab/docker-compose/pull/86): + - Fix interfaces not being exposed in typings file # 0.20.1 / 2019-07-26 ## :tada: Enhancements -* [#84](https://github.com/PDMLab/docker-compose/pull/84): - * Set Node 6.0 as minimum version +- [#84](https://github.com/PDMLab/docker-compose/pull/84): + - Set Node 6.0 as minimum version # 0.20.0 / 2019-07-23 ## :tada: Enhancements -* [#83](https://github.com/PDMLab/docker-compose/pull/83): - * Migrate to Typescript +- [#83](https://github.com/PDMLab/docker-compose/pull/83): + - Migrate to Typescript # 0.19.0 / 2019-07-13 ## :tada: Enhancements -* [#77](https://github.com/PDMLab/docker-compose/pull/77): - * handle error based on exit code - * replace `tape` with `jest` +- [#77](https://github.com/PDMLab/docker-compose/pull/77): + - handle error based on exit code + - replace `tape` with `jest` # 0.18.0 / 2019-07-10 ## :tada: Enhancements -* [#82](https://github.com/PDMLab/docker-compose/pull/82): Allow passing an array as command to `run` and `exec` +- [#82](https://github.com/PDMLab/docker-compose/pull/82): Allow passing an array as command to `run` and `exec` # 0.17.3 / 2019-05-29 ## :bug: Fixes -* [#69](https://github.com/PDMLab/docker-compose/pull/76): Fix declaration for `logs` function +- [#69](https://github.com/PDMLab/docker-compose/pull/76): Fix declaration for `logs` function # 0.17.2 / 2019-05-02 ## :nut_and_bolt: Other -* [#69](https://github.com/PDMLab/docker-compose/issues/69): Remove winston dependency and lib/log +- [#69](https://github.com/PDMLab/docker-compose/issues/69): Remove winston dependency and lib/log # 0.17.1 / 2019-05-01 ## :bug: Fixes -* [#66](https://github.com/PDMLab/docker-compose/issues/66): Trailing commas causing syntax error on NodeJS 6.x +- [#66](https://github.com/PDMLab/docker-compose/issues/66): Trailing commas causing syntax error on NodeJS 6.x # 0.17.0 / 2019-04-30 ## :tada: Enhancements -* [#58](https://github.com/PDMLab/docker-compose/issues/58): Expose docker-compose exit code in results +- [#58](https://github.com/PDMLab/docker-compose/issues/58): Expose docker-compose exit code in results diff --git a/src/v2.ts b/src/v2.ts index ad350bd1..65ab9a6b 100644 --- a/src/v2.ts +++ b/src/v2.ts @@ -319,6 +319,8 @@ export const downAll = function ( return execCompose('down', [], options) } +export const down = downAll + export const downMany = function ( services: string[], options?: IDockerComposeOptions @@ -590,6 +592,7 @@ export default { upAll, upMany, upOne, + down, downAll, downOne, downMany, From ecdc012b529dd5b0bff9263c473db62127a21787 Mon Sep 17 00:00:00 2001 From: Angelo Cali Date: Tue, 20 Feb 2024 01:31:33 +0100 Subject: [PATCH 2/2] fix changelog stars to minus problem --- CHANGELOG.md | 167 +++++++++++++++++++++++++++++---------------------- 1 file changed, 95 insertions(+), 72 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6193ceb4..0ed20777 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file. See [standa ### Bug Fixes -- Adds `down()` as alias for `downAll()` to support compatbility with existing packages which use this project +* Adds `down()` as alias for `downAll()` to support compatbility with existing packages which use this project ### [0.24.5](https://github.com/PDMLab/docker-compose/compare/v0.24.4...v0.24.5) (2024-02-19) @@ -12,159 +12,183 @@ All notable changes to this project will be documented in this file. See [standa ### [0.24.3](https://github.com/PDMLab/docker-compose/compare/v0.24.2...v0.24.3) (2023-10-30) + ### Features -- ps supports json format ([4498eb4](https://github.com/PDMLab/docker-compose/commit/4498eb481c52f852247342b495ff66c5b465f895)) +* ps supports json format ([4498eb4](https://github.com/PDMLab/docker-compose/commit/4498eb481c52f852247342b495ff66c5b465f895)) ### [0.24.2](https://github.com/PDMLab/docker-compose/compare/v0.24.1...v0.24.2) (2023-07-27) + ### Bug Fixes -- **ci:** shadow ci command using yarn ([bf0d1b6](https://github.com/PDMLab/docker-compose/commit/bf0d1b6a7ebc80b0ac158bbffc277b3c118545df)) +* **ci:** shadow ci command using yarn ([bf0d1b6](https://github.com/PDMLab/docker-compose/commit/bf0d1b6a7ebc80b0ac158bbffc277b3c118545df)) ### [0.24.1](https://github.com/PDMLab/docker-compose/compare/v0.24.0...v0.24.1) (2023-05-14) + ### Bug Fixes -- Remove unnecessary console.log in v2 api ([#241](https://github.com/PDMLab/docker-compose/issues/241)) ([75ab935](https://github.com/PDMLab/docker-compose/commit/75ab935dcdf5c32cf44643d4d74ba6b30620a31a)) +* Remove unnecessary console.log in v2 api ([#241](https://github.com/PDMLab/docker-compose/issues/241)) ([75ab935](https://github.com/PDMLab/docker-compose/commit/75ab935dcdf5c32cf44643d4d74ba6b30620a31a)) ## [0.24.0](https://github.com/PDMLab/docker-compose/compare/v0.23.19...v0.24.0) (2023-04-28) + ### Features -- support docker compose v2 plugin version ([#228](https://github.com/PDMLab/docker-compose/issues/228)) ([95250be](https://github.com/PDMLab/docker-compose/commit/95250beeee1b5a1f9433138870392b611a3eec93)) +* support docker compose v2 plugin version ([#228](https://github.com/PDMLab/docker-compose/issues/228)) ([95250be](https://github.com/PDMLab/docker-compose/commit/95250beeee1b5a1f9433138870392b611a3eec93)) ### [0.23.20-preview.0](https://github.com/PDMLab/docker-compose/compare/v0.23.19...v0.23.20-preview.0) (2023-04-27) + ### Features -- support docker compose v2 plugin version ([81e72e9](https://github.com/PDMLab/docker-compose/commit/81e72e9985aba05474463306852501287ad32680)) +* support docker compose v2 plugin version ([81e72e9](https://github.com/PDMLab/docker-compose/commit/81e72e9985aba05474463306852501287ad32680)) + ### Bug Fixes -- expect volume name to match changed folder name ([85c4c15](https://github.com/PDMLab/docker-compose/commit/85c4c150ce5191c95116e98145e2d3c75604a4a4)) -- **build:** exclude old tests temporarily ([36d543d](https://github.com/PDMLab/docker-compose/commit/36d543db56822be95c9cd31eaa890a4c46e789a4)) -- **lint:** no-useless-escape for \" characters ([fcabbc2](https://github.com/PDMLab/docker-compose/commit/fcabbc2ea7c7d42f15f45a26badab9fe73030a6c)) -- **lint:** remove jest plugin reference ([892e6db](https://github.com/PDMLab/docker-compose/commit/892e6db60302ef734e5b42b74da6f583c1fb9e52)) +* expect volume name to match changed folder name ([85c4c15](https://github.com/PDMLab/docker-compose/commit/85c4c150ce5191c95116e98145e2d3c75604a4a4)) +* **build:** exclude old tests temporarily ([36d543d](https://github.com/PDMLab/docker-compose/commit/36d543db56822be95c9cd31eaa890a4c46e789a4)) +* **lint:** no-useless-escape for \" characters ([fcabbc2](https://github.com/PDMLab/docker-compose/commit/fcabbc2ea7c7d42f15f45a26badab9fe73030a6c)) +* **lint:** remove jest plugin reference ([892e6db](https://github.com/PDMLab/docker-compose/commit/892e6db60302ef734e5b42b74da6f583c1fb9e52)) ### [0.23.19](https://github.com/PDMLab/docker-compose/compare/v0.23.18...v0.23.19) (2023-02-05) ### [0.23.18](https://github.com/PDMLab/docker-compose/compare/v0.23.17...v0.23.18) (2023-01-24) + ### Bug Fixes -- add stopMany to default exports ([ff914e9](https://github.com/PDMLab/docker-compose/commit/ff914e910cb963b8fa7f283a1f51cb66fae0f52b)) +* add stopMany to default exports ([ff914e9](https://github.com/PDMLab/docker-compose/commit/ff914e910cb963b8fa7f283a1f51cb66fae0f52b)) ### [0.23.17](https://github.com/PDMLab/docker-compose/compare/v0.23.16...v0.23.17) (2022-01-18) + ### Bug Fixes -- ps --services trim on undefined ([#201](https://github.com/PDMLab/docker-compose/issues/201)) ([5df547e](https://github.com/PDMLab/docker-compose/commit/5df547e0af97bc6ba2ac96aab26eb5bf4b60e2b8)) +* ps --services trim on undefined ([#201](https://github.com/PDMLab/docker-compose/issues/201)) ([5df547e](https://github.com/PDMLab/docker-compose/commit/5df547e0af97bc6ba2ac96aab26eb5bf4b60e2b8)) ### [0.23.16](https://github.com/PDMLab/docker-compose/compare/v0.23.15...v0.23.16) (2022-01-16) + ### Features -- stop many ([#200](https://github.com/PDMLab/docker-compose/issues/200)) ([f10a9b6](https://github.com/PDMLab/docker-compose/commit/f10a9b610160c4ac06d0d38cbd9db4a6fe7761c9)) +* stop many ([#200](https://github.com/PDMLab/docker-compose/issues/200)) ([f10a9b6](https://github.com/PDMLab/docker-compose/commit/f10a9b610160c4ac06d0d38cbd9db4a6fe7761c9)) ### [0.23.15](https://github.com/PDMLab/docker-compose/compare/v0.23.14...v0.23.15) (2022-01-14) + ### Bug Fixes -- **#178:** fix quiet trim issue, add tests ([#197](https://github.com/PDMLab/docker-compose/issues/197)) ([2016bc7](https://github.com/PDMLab/docker-compose/commit/2016bc75db9996155d61f3d7f93c98c5fb960df1)) +* **#178:** fix quiet trim issue, add tests ([#197](https://github.com/PDMLab/docker-compose/issues/197)) ([2016bc7](https://github.com/PDMLab/docker-compose/commit/2016bc75db9996155d61f3d7f93c98c5fb960df1)) ### [0.23.14](https://github.com/PDMLab/docker-compose/compare/v0.23.13...v0.23.14) (2021-11-29) + ### Features -- passing callback to report progress ([#191](https://github.com/PDMLab/docker-compose/issues/191)) ([f60e4d5](https://github.com/PDMLab/docker-compose/commit/f60e4d5a186ea3ca0b99e8443e1c4006d75be5a7)) +* passing callback to report progress ([#191](https://github.com/PDMLab/docker-compose/issues/191)) ([f60e4d5](https://github.com/PDMLab/docker-compose/commit/f60e4d5a186ea3ca0b99e8443e1c4006d75be5a7)) ### [0.23.13](https://github.com/PDMLab/docker-compose/compare/v0.23.12...v0.23.13) (2021-07-20) + ### Features -- single container pause and unpause added ([5921b51](https://github.com/PDMLab/docker-compose/commit/5921b51977cbd51ffcb1def458738ccfccbe1dd9)) +* single container pause and unpause added ([5921b51](https://github.com/PDMLab/docker-compose/commit/5921b51977cbd51ffcb1def458738ccfccbe1dd9)) + ### Bug Fixes -- now lints correctly ([74b4d6e](https://github.com/PDMLab/docker-compose/commit/74b4d6ea22d7e1b9ebbbbe9874e5314b7adfa31a)) +* now lints correctly ([74b4d6e](https://github.com/PDMLab/docker-compose/commit/74b4d6ea22d7e1b9ebbbbe9874e5314b7adfa31a)) ### [0.23.12](https://github.com/PDMLab/docker-compose/compare/v0.23.11...v0.23.12) (2021-06-06) + ### Features -- **dx:** add default export ([c4b6087](https://github.com/PDMLab/docker-compose/commit/c4b60872aecfdc6610e9b2141a45ea7785820af7)) +* **dx:** add default export ([c4b6087](https://github.com/PDMLab/docker-compose/commit/c4b60872aecfdc6610e9b2141a45ea7785820af7)) ### [0.23.11](https://github.com/PDMLab/docker-compose/compare/v0.23.10...v0.23.11) (2021-06-04) ### [0.23.10](https://github.com/PDMLab/docker-compose/compare/v0.23.9...v0.23.10) (2021-05-11) + ### Bug Fixes -- fix mapping ipv6-based port mappings ([53fb971](https://github.com/PDMLab/docker-compose/commit/53fb97196f3cf0ebb229d127e9b630c863eaf8fc)) -- fix mapping ipv6-based port mappings ([6dec0c6](https://github.com/PDMLab/docker-compose/commit/6dec0c6bb6220b06eff188a26220b405d632bed3)) -- fix mapping ipv6-based port mappings ([dbdb900](https://github.com/PDMLab/docker-compose/commit/dbdb9008f25d237254312d79382e342d03f4c5bb)) -- fix mapping ipv6-based port mappings ([8aa8465](https://github.com/PDMLab/docker-compose/commit/8aa846553c2d045f610392bf38569fb3579b9aa6)) -- fix mapping ipv6-based port mappings ([21b63cb](https://github.com/PDMLab/docker-compose/commit/21b63cbc53635ee8532c388e57f4552f1b3ae6e3)) -- fix mapping ipv6-based port mappings ([48c9f08](https://github.com/PDMLab/docker-compose/commit/48c9f0841af2bbcb8ec666a38eee3ab8236304d0)) -- fix mapping ipv6-based port mappings ([e7013df](https://github.com/PDMLab/docker-compose/commit/e7013dfab10e4e369ee076b465c40a5bcb50802b)) +* fix mapping ipv6-based port mappings ([53fb971](https://github.com/PDMLab/docker-compose/commit/53fb97196f3cf0ebb229d127e9b630c863eaf8fc)) +* fix mapping ipv6-based port mappings ([6dec0c6](https://github.com/PDMLab/docker-compose/commit/6dec0c6bb6220b06eff188a26220b405d632bed3)) +* fix mapping ipv6-based port mappings ([dbdb900](https://github.com/PDMLab/docker-compose/commit/dbdb9008f25d237254312d79382e342d03f4c5bb)) +* fix mapping ipv6-based port mappings ([8aa8465](https://github.com/PDMLab/docker-compose/commit/8aa846553c2d045f610392bf38569fb3579b9aa6)) +* fix mapping ipv6-based port mappings ([21b63cb](https://github.com/PDMLab/docker-compose/commit/21b63cbc53635ee8532c388e57f4552f1b3ae6e3)) +* fix mapping ipv6-based port mappings ([48c9f08](https://github.com/PDMLab/docker-compose/commit/48c9f0841af2bbcb8ec666a38eee3ab8236304d0)) +* fix mapping ipv6-based port mappings ([e7013df](https://github.com/PDMLab/docker-compose/commit/e7013dfab10e4e369ee076b465c40a5bcb50802b)) ### [0.23.9](https://github.com/PDMLab/docker-compose/compare/v0.23.8...v0.23.9) (2021-05-08) + ### Features -- Add execPath option to set path to docker-compose executable ([58f09f4](https://github.com/PDMLab/docker-compose/commit/58f09f4c7414df5a6ee7af7f77d2af297d84d6c1)) +* Add execPath option to set path to docker-compose executable ([58f09f4](https://github.com/PDMLab/docker-compose/commit/58f09f4c7414df5a6ee7af7f77d2af297d84d6c1)) ### [0.23.8](https://github.com/PDMLab/docker-compose/compare/v0.23.7...v0.23.8) (2021-04-15) + ### Bug Fixes -- ignore vuepress cache + temp files on release ([#148](https://github.com/PDMLab/docker-compose/issues/148)) ([e58387d](https://github.com/PDMLab/docker-compose/commit/e58387d82e4586f7a8156446f12c999c9a6f9f42)) +* ignore vuepress cache + temp files on release ([#148](https://github.com/PDMLab/docker-compose/issues/148)) ([e58387d](https://github.com/PDMLab/docker-compose/commit/e58387d82e4586f7a8156446f12c999c9a6f9f42)) ### [0.23.7](https://github.com/PDMLab/docker-compose/compare/v0.23.5...v0.23.7) (2021-04-14) + ### Features -- allow to pass docker compose configuration as string ([e8c14d3](https://github.com/PDMLab/docker-compose/commit/e8c14d318ce440ab02c858b1ca1dbeeb2985dc00)) -- make result for `config --services` command type safe ([6f105ca](https://github.com/PDMLab/docker-compose/commit/6f105ca16098ba8de11f85ec0d092130b65293e4)) -- make result for `config --volumes` command type safe ([51b20b4](https://github.com/PDMLab/docker-compose/commit/51b20b43d6eccac45653553437a546e4ccee51a6)) -- make result for `config` command type safe ([a2f5a4e](https://github.com/PDMLab/docker-compose/commit/a2f5a4ec0eee8fcbd60fa12f969b8eb83a4730fb)) -- make result for `port` command type safe ([70a98f4](https://github.com/PDMLab/docker-compose/commit/70a98f473b7bd46f0aa03c1a4334fa2abf6c3455)) -- make result for `ps` command type safe ([880d252](https://github.com/PDMLab/docker-compose/commit/880d2522b5777db30c48569a41dd09fb7e46a4b3)) -- make result for `version` command type safe ([a7da038](https://github.com/PDMLab/docker-compose/commit/a7da0380a8464bbd2efc2c16b70b67d4fdf77c24)) +* allow to pass docker compose configuration as string ([e8c14d3](https://github.com/PDMLab/docker-compose/commit/e8c14d318ce440ab02c858b1ca1dbeeb2985dc00)) +* make result for `config --services` command type safe ([6f105ca](https://github.com/PDMLab/docker-compose/commit/6f105ca16098ba8de11f85ec0d092130b65293e4)) +* make result for `config --volumes` command type safe ([51b20b4](https://github.com/PDMLab/docker-compose/commit/51b20b43d6eccac45653553437a546e4ccee51a6)) +* make result for `config` command type safe ([a2f5a4e](https://github.com/PDMLab/docker-compose/commit/a2f5a4ec0eee8fcbd60fa12f969b8eb83a4730fb)) +* make result for `port` command type safe ([70a98f4](https://github.com/PDMLab/docker-compose/commit/70a98f473b7bd46f0aa03c1a4334fa2abf6c3455)) +* make result for `ps` command type safe ([880d252](https://github.com/PDMLab/docker-compose/commit/880d2522b5777db30c48569a41dd09fb7e46a4b3)) +* make result for `version` command type safe ([a7da038](https://github.com/PDMLab/docker-compose/commit/a7da0380a8464bbd2efc2c16b70b67d4fdf77c24)) + ### Bug Fixes -- filter empty entries from `config --services` command ([ed91eba](https://github.com/PDMLab/docker-compose/commit/ed91eba770d3a32d82dda4e927d31ed4b6d01db4)) -- **test:** fix broken tests ([afb2b11](https://github.com/PDMLab/docker-compose/commit/afb2b1116b12c4800563e85adb15ebd39e030516)) +* filter empty entries from `config --services` command ([ed91eba](https://github.com/PDMLab/docker-compose/commit/ed91eba770d3a32d82dda4e927d31ed4b6d01db4)) +* **test:** fix broken tests ([afb2b11](https://github.com/PDMLab/docker-compose/commit/afb2b1116b12c4800563e85adb15ebd39e030516)) ### [0.23.6](https://github.com/PDMLab/docker-compose/compare/v0.23.5...v0.23.6) (2021-01-06) + ### Features -- allow to pass docker compose configuration as string ([e8c14d3](https://github.com/PDMLab/docker-compose/commit/e8c14d318ce440ab02c858b1ca1dbeeb2985dc00)) +* allow to pass docker compose configuration as string ([e8c14d3](https://github.com/PDMLab/docker-compose/commit/e8c14d318ce440ab02c858b1ca1dbeeb2985dc00)) ### [0.23.5](https://github.com/PDMLab/docker-compose/compare/v0.23.4...v0.23.5) (2020-07-10) + ### Bug Fixes -- update flags incompatible with detached mode ([c808fa2](https://github.com/PDMLab/docker-compose/commit/c808fa2b90b2fd5db239685d101ccaa554ad98cf)) +* update flags incompatible with detached mode ([c808fa2](https://github.com/PDMLab/docker-compose/commit/c808fa2b90b2fd5db239685d101ccaa554ad98cf)) ### [0.23.4](https://github.com/PDMLab/docker-compose/compare/v0.23.3...v0.23.4) (2020-04-23) + ### Features -- allow passing service names to `rm` function ([3a68db7](https://github.com/PDMLab/docker-compose/commit/3a68db75e3b879f12fe3c6cedbc9ad09a52914a5)) +* allow passing service names to `rm` function ([3a68db7](https://github.com/PDMLab/docker-compose/commit/3a68db75e3b879f12fe3c6cedbc9ad09a52914a5)) ### [0.23.3](https://github.com/PDMLab/docker-compose/compare/v0.23.2...v0.23.3) (2020-03-06) + ### Features -- add ability to pass --abort-on-container-exit flag to up methods ([e85af8c](https://github.com/PDMLab/docker-compose/commit/e85af8c092a54a3fb48519bb39956324bbef4fc2)) +* add ability to pass --abort-on-container-exit flag to up methods ([e85af8c](https://github.com/PDMLab/docker-compose/commit/e85af8c092a54a3fb48519bb39956324bbef4fc2)) + ### Bug Fixes -- reset jest set timeout to original value ([c4ed7ed](https://github.com/PDMLab/docker-compose/commit/c4ed7ed2de9c4c161518ab1d1fc50877df4c7fa2)) +* reset jest set timeout to original value ([c4ed7ed](https://github.com/PDMLab/docker-compose/commit/c4ed7ed2de9c4c161518ab1d1fc50877df4c7fa2)) ### [0.23.2](https://github.com/PDMLab/docker-compose/compare/v0.23.1...v0.23.2) (2019-12-31) @@ -174,104 +198,103 @@ All notable changes to this project will be documented in this file. See [standa ## :tada: Enhancements -- [#97](https://github.com/PDMLab/docker-compose/pull/97): - - Add a `version` function +* [#97](https://github.com/PDMLab/docker-compose/pull/97): + * Add a `version` function # 0.22.2 / 2019-08-31 ## :bug: Fixes -- [#94](https://github.com/PDMLab/docker-compose/pull/94): - - Fix a copy-paste typo for pull commands +* [#94](https://github.com/PDMLab/docker-compose/pull/94): + * Fix a copy-paste typo for pull commands # 0.22.1 / 2019-08-31 ## :tada: Enhancements -- [#93](https://github.com/PDMLab/docker-compose/pull/93): - - Add pull command methods to readme +* [#93](https://github.com/PDMLab/docker-compose/pull/93): + * Add pull command methods to readme ## :lock: Security Fixes - -- [#92](https://github.com/PDMLab/docker-compose/pull/92): - - Fix `eslint-utils` security issue +* [#92](https://github.com/PDMLab/docker-compose/pull/92): + * Fix `eslint-utils` security issue # 0.22.0 / 2019-08-30 ## :tada: Enhancements -- [#90](https://github.com/PDMLab/docker-compose/pull/90): - - Add `pullOne`, `pullMany` and `pullAll` methods +* [#90](https://github.com/PDMLab/docker-compose/pull/90): + * Add `pullOne`, `pullMany` and `pullAll` methods # 0.21.0 / 2019-08-15 ## :tada: Enhancements -- [#89](https://github.com/PDMLab/docker-compose/pull/89): - - Add `stopOne()` command +* [#89](https://github.com/PDMLab/docker-compose/pull/89): + * Add `stopOne()` command # 0.20.2 / 2019-07-30 ## :tada: Enhancements -- [#87](https://github.com/PDMLab/docker-compose/pull/87): - - Use proper `es2015` library (for Promises, etc.) in `tsconfig` +* [#87](https://github.com/PDMLab/docker-compose/pull/87): + * Use proper `es2015` library (for Promises, etc.) in `tsconfig` ## :bug: Fixes -- [#87](https://github.com/PDMLab/docker-compose/pull/87): - - Fix linting after build was called -- [#86](https://github.com/PDMLab/docker-compose/pull/86): - - Fix interfaces not being exposed in typings file +* [#87](https://github.com/PDMLab/docker-compose/pull/87): + * Fix linting after build was called +* [#86](https://github.com/PDMLab/docker-compose/pull/86): + * Fix interfaces not being exposed in typings file # 0.20.1 / 2019-07-26 ## :tada: Enhancements -- [#84](https://github.com/PDMLab/docker-compose/pull/84): - - Set Node 6.0 as minimum version +* [#84](https://github.com/PDMLab/docker-compose/pull/84): + * Set Node 6.0 as minimum version # 0.20.0 / 2019-07-23 ## :tada: Enhancements -- [#83](https://github.com/PDMLab/docker-compose/pull/83): - - Migrate to Typescript +* [#83](https://github.com/PDMLab/docker-compose/pull/83): + * Migrate to Typescript # 0.19.0 / 2019-07-13 ## :tada: Enhancements -- [#77](https://github.com/PDMLab/docker-compose/pull/77): - - handle error based on exit code - - replace `tape` with `jest` +* [#77](https://github.com/PDMLab/docker-compose/pull/77): + * handle error based on exit code + * replace `tape` with `jest` # 0.18.0 / 2019-07-10 ## :tada: Enhancements -- [#82](https://github.com/PDMLab/docker-compose/pull/82): Allow passing an array as command to `run` and `exec` +* [#82](https://github.com/PDMLab/docker-compose/pull/82): Allow passing an array as command to `run` and `exec` # 0.17.3 / 2019-05-29 ## :bug: Fixes -- [#69](https://github.com/PDMLab/docker-compose/pull/76): Fix declaration for `logs` function +* [#69](https://github.com/PDMLab/docker-compose/pull/76): Fix declaration for `logs` function # 0.17.2 / 2019-05-02 ## :nut_and_bolt: Other -- [#69](https://github.com/PDMLab/docker-compose/issues/69): Remove winston dependency and lib/log +* [#69](https://github.com/PDMLab/docker-compose/issues/69): Remove winston dependency and lib/log # 0.17.1 / 2019-05-01 ## :bug: Fixes -- [#66](https://github.com/PDMLab/docker-compose/issues/66): Trailing commas causing syntax error on NodeJS 6.x +* [#66](https://github.com/PDMLab/docker-compose/issues/66): Trailing commas causing syntax error on NodeJS 6.x # 0.17.0 / 2019-04-30 ## :tada: Enhancements -- [#58](https://github.com/PDMLab/docker-compose/issues/58): Expose docker-compose exit code in results +* [#58](https://github.com/PDMLab/docker-compose/issues/58): Expose docker-compose exit code in results