Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Compose V2.0.0 #13474

Closed
wants to merge 8 commits into from
Closed

Compose V2.0.0 #13474

wants to merge 8 commits into from

Conversation

ndeloof
Copy link
Contributor

@ndeloof ndeloof commented Sep 7, 2021

Proposed changes

Update documentation as Compose V2 has been released

Unreleased project version (optional)

This change only applies once github.com/docker/compose has released v2.0.0

@netlify
Copy link

netlify bot commented Sep 7, 2021

✔️ Deploy Preview for docsdocker ready!

🔨 Explore the source changes: b318028

🔍 Inspect the deploy log: https://app.netlify.com/sites/docsdocker/deploys/6141e276cf0cbf0008291dde

😎 Browse the preview: https://deploy-preview-13474--docsdocker.netlify.app

@ndeloof ndeloof force-pushed the compose_v2_GA branch 4 times, most recently from 24a624c to 3c376b1 Compare September 7, 2021 13:16
compose/cli-command.md Outdated Show resolved Hide resolved
compose/install.md Outdated Show resolved Hide resolved
@ndeloof ndeloof force-pushed the compose_v2_GA branch 5 times, most recently from d112883 to 4dc7d44 Compare September 15, 2021 06:28
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
@ndeloof ndeloof changed the title [do not merge] compose V2 G.A Compose V2.0.0 Sep 29, 2021
@ndeloof ndeloof marked this pull request as ready for review September 29, 2021 07:03
Copy link
Member

@StefanScherer StefanScherer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added a few suggestions how to install the Compose v2 plugin on Windows Server.

@@ -95,114 +93,62 @@ on Microsoft Windows Server and want to install Docker Compose.
Invoke-WebRequest "https://github.com/docker/compose/releases/download/{{site.compose_version}}/docker-compose-Windows-x86_64.exe" -UseBasicParsing -OutFile $Env:ProgramFiles\Docker\docker-compose.exe
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Invoke-WebRequest "https://github.com/docker/compose/releases/download/{{site.compose_version}}/docker-compose-Windows-x86_64.exe" -UseBasicParsing -OutFile $Env:ProgramFiles\Docker\docker-compose.exe
mkdir $Env:ProgramFiles\Docker\cli-plugins
Invoke-WebRequest "https://github.com/docker/compose/releases/download/v{{site.compose_version}}/docker-compose-windows-amd64.exe" -UseBasicParsing -OutFile $Env:ProgramFiles\Docker\cli-plugins\docker-compose.exe

@@ -95,114 +93,62 @@ on Microsoft Windows Server and want to install Docker Compose.
Invoke-WebRequest "https://github.com/docker/compose/releases/download/{{site.compose_version}}/docker-compose-Windows-x86_64.exe" -UseBasicParsing -OutFile $Env:ProgramFiles\Docker\docker-compose.exe
```

**Note**: On Windows Server 2019, you can add the Compose executable to `$Env:ProgramFiles\Docker`. Because this directory is registered in the system `PATH`, you can run the `docker-compose --version` command on the subsequent step with no additional configuration.
**Note**: On Windows Server 2019, you can add the Compose executable to `$Env:ProgramFiles\Docker`. Because this directory is registered in the system `PATH`, you can run the `docker compose --version` command on the subsequent step with no additional configuration.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**Note**: On Windows Server 2019, you can add the Compose executable to `$Env:ProgramFiles\Docker`. Because this directory is registered in the system `PATH`, you can run the `docker compose --version` command on the subsequent step with no additional configuration.
**Note**: On Windows Server 2019, you can add the Compose executable to `$Env:ProgramFiles\Docker\cli-plugins`. Because this directory is used for Docker CLI plugins, you can run the `docker compose --version` command on the subsequent step with no additional configuration.

- Blank lines are ignored.
- Multi-line values can be wrapped using double quotes.
- Values can be wrapped by single or double quotes, which will be removed from actual value
- Variables defined by dolar sign `$` inside value are substitued, unless value is wrapped by single quotes
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Variables defined by dolar sign `$` inside value are substitued, unless value is wrapped by single quotes
- Variables defined by dollar sign `$` inside value are substituted, unless value is wrapped by single quotes


- Compose expects each line in an `env` file to be in `VAR=VAL` format.
- Lines beginning with `#` are processed as comments and ignored.
- Blank lines are ignored.
- There is no special handling of quotation marks. This means that
**they are part of the VAL**.

### Compose 2.x

Compose V2 adopt the [Ruby-style dotEnv file syntax](https://github.com/bkeepers/dotenv#usage),

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Compose V2 adopt the [Ruby-style dotEnv file syntax](https://github.com/bkeepers/dotenv#usage),
Compose V2 adopts the [Ruby-style dotenv file syntax](https://github.com/bkeepers/dotenv#usage),

@@ -20,14 +20,50 @@ The project directory is specified by the order of precedence:

## Syntax rules

The following syntax rules apply to the `.env` file:
The "dotEnv" file format is a _de facto_ convention, not a standard with no clear specification,

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The "dotEnv" file format is a _de facto_ convention, not a standard with no clear specification,
The "dotenv" file format is a _de facto_ convention, not a standard with no clear specification,

@craig-osterhout craig-osterhout added the area/compose Relates to docker-compose.yml spec or docker-compose binary label Aug 4, 2022
@usha-mandya
Copy link
Member

Closing this PR as the updates are merged and published through other PRs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/compose Relates to docker-compose.yml spec or docker-compose binary
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants