tyler.durden
/
compose
mirror of https://github.com/docker/compose.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update README and CI workflows to match main branch 

Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
This commit is contained in:
Guillaume Lours 2023-08-10 11:28:59 +02:00 committed by Nicolas De loof
parent bfa54081d4
commit 52103cce74
4 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/ci.yml vendored
View File

@ -7,7 +7,7 @@ concurrency:
on: on:
push: push:
branches: branches:
- 'v2' - 'main'
tags: tags:
- 'v*' - 'v*'
pull_request: pull_request:

2
.github/workflows/merge.yml vendored
View File

@ -7,7 +7,7 @@ concurrency:
on: on:
push: push:
branches: branches:
- 'v2' - 'main'
tags: tags:
- 'v*' - 'v*'

2
.github/workflows/scorecards.yml vendored
View File

@ -5,7 +5,7 @@ on:
schedule: schedule:
- cron: '44 9 * * 4' - cron: '44 9 * * 4'
push: push:
branches: [ "v2" ] branches: [ "main" ]
# Declare default permissions as read only. # Declare default permissions as read only.
permissions: read-all permissions: read-all

16
README.md
View File

@ -6,13 +6,14 @@
+ [Linux](#linux) + [Linux](#linux)
- [Quick Start](#quick-start) - [Quick Start](#quick-start)
- [Contributing](#contributing) - [Contributing](#contributing)
- [Legacy](#legacy)
# Docker Compose v2 # Docker Compose v2
[![GitHub release](https://img.shields.io/github/release/docker/compose.svg?style=flat-square)](https://github.com/docker/compose/releases/latest) [![GitHub release](https://img.shields.io/github/release/docker/compose.svg?style=flat-square)](https://github.com/docker/compose/releases/latest)
[![PkgGoDev](https://img.shields.io/badge/go.dev-docs-007d9c?style=flat-square&logo=go&logoColor=white)](https://pkg.go.dev/github.com/docker/compose/v2) [![PkgGoDev](https://img.shields.io/badge/go.dev-docs-007d9c?style=flat-square&logo=go&logoColor=white)](https://pkg.go.dev/github.com/docker/compose/v2)
[![Build Status](https://img.shields.io/github/workflow/status/docker/compose/ci?label=ci&logo=github&style=flat-square)](https://github.com/docker/compose/actions?query=workflow%3Aci) [![Build Status](https://img.shields.io/github/actions/workflow/status/docker/compose/ci.yml?label=ci&logo=github&style=flat-square)](https://github.com/docker/compose/actions?query=workflow%3Aci)
[![Go Report Card](https://goreportcard.com/badge/github.com/docker/compose/v2?style=flat-square)](https://goreportcard.com/report/github.com/docker/compose/v2) [![Go Report Card](https://goreportcard.com/badge/github.com/docker/compose/v2?style=flat-square)](https://goreportcard.com/report/github.com/docker/compose/v2)
[![Codecov](https://codecov.io/gh/docker/compose/branch/master/graph/badge.svg?token=HP3K4Y4ctu)](https://codecov.io/gh/docker/compose) [![Codecov](https://codecov.io/gh/docker/compose/branch/main/graph/badge.svg?token=HP3K4Y4ctu)](https://codecov.io/gh/docker/compose)
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/docker/compose/badge)](https://api.securityscorecards.dev/projects/github.com/docker/compose) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/docker/compose/badge)](https://api.securityscorecards.dev/projects/github.com/docker/compose)
![Docker Compose](logo.png?raw=true "Docker Compose Logo") ![Docker Compose](logo.png?raw=true "Docker Compose Logo")
@ -23,12 +24,6 @@ your application are configured.
Once you have a Compose file, you can create and start your application with a Once you have a Compose file, you can create and start your application with a
single command: `docker compose up`. single command: `docker compose up`.
# About update and backward compatibility
Docker Compose V2 is a major version bump release of Docker Compose. It has been completely rewritten from scratch in Golang (V1 was in Python). The installation instructions for Compose V2 differ from V1. V2 is not a standalone binary anymore, and installation scripts will have to be adjusted. Some commands are different.
For a smooth transition from legacy docker-compose 1.xx, please consider installing [compose-switch](https://github.com/docker/compose-switch) to translate `docker-compose ...` commands into Compose V2's `docker compose .... `. Also check V2's `--compatibility` flag.
# Where to get Docker Compose # Where to get Docker Compose
### Windows and macOS ### Windows and macOS
@ -85,3 +80,8 @@ Want to help develop Docker Compose? Check out our
If you find an issue, please report it on the If you find an issue, please report it on the
[issue tracker](https://github.com/docker/compose/issues/new/choose). [issue tracker](https://github.com/docker/compose/issues/new/choose).
Legacy
-------------
The Python version of Compose is available under the `v1` [branch](https://github.com/docker/compose/tree/v1)